From 40016ea3ff498a4afad89c72f4e59c03edc84d10 Mon Sep 17 00:00:00 2001 From: Nicola Soranzo Date: Thu, 15 Jun 2023 19:18:52 +0100 Subject: [PATCH] Add configuration file for Read the Docs See https://blog.readthedocs.com/migrate-configuration-v2/ Also update copyright and author. --- .readthedocs.yaml | 28 ++++++++++++++++++++++++++++ LICENSE | 2 +- docs/conf.py | 8 ++++---- 3 files changed, 33 insertions(+), 5 deletions(-) create mode 100644 .readthedocs.yaml diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 000000000..471512888 --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,28 @@ +# .readthedocs.yaml +# Read the Docs configuration file +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + +# Required +version: 2 + +# Set the OS, Python version and other tools you might need +build: + os: ubuntu-22.04 + tools: + python: "3.11" + +# Build documentation in the docs/ directory with Sphinx +sphinx: + configuration: docs/conf.py + +# Optionally build your docs in additional formats such as PDF and ePub +formats: + - pdf + +# Optional but recommended, declare the Python requirements required +# to build your documentation +# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html +python: + install: + - path: . + - requirements: docs/requirements.txt diff --git a/LICENSE b/LICENSE index 34748737b..53734d71c 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ MIT License -Copyright (c) 2012-2020 Galaxy Project +Copyright (c) 2012-2023 Galaxy Project Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/docs/conf.py b/docs/conf.py index 99cee4a0d..c478e2008 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -42,7 +42,7 @@ # General information about the project. project = "BioBlend" -copyright = "2012-2016, Enis Afgan" +copyright = "2012-2023, Galaxy Project" # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the @@ -192,7 +192,7 @@ # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, author, documentclass [howto/manual]). latex_documents = [ - ("index", "BioBlend.tex", "BioBlend Documentation", "Enis Afgan", "manual"), + ("index", "BioBlend.tex", "BioBlend Documentation", "Galaxy Project", "manual"), ] # The name of an image file (relative to this directory) to place at the top of @@ -220,7 +220,7 @@ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). -man_pages = [("index", "bioblend", "BioBlend Documentation", ["Enis Afgan"], 1)] +man_pages = [("index", "bioblend", "BioBlend Documentation", ["Galaxy Project"], 1)] # If true, show URL addresses after external links. # man_show_urls = False @@ -236,7 +236,7 @@ "index", "BioBlend", "BioBlend Documentation", - "Enis Afgan", + "Galaxy Project", "BioBlend", "One line description of project.", "Miscellaneous",