Skip to content

Commit

Permalink
Add configuration file for Read the Docs
Browse files Browse the repository at this point in the history
See https://blog.readthedocs.com/migrate-configuration-v2/

Also update copyright and author.
  • Loading branch information
nsoranzo committed Jun 15, 2023
1 parent 5c5189f commit 67cbc56
Show file tree
Hide file tree
Showing 3 changed files with 32 additions and 5 deletions.
27 changes: 27 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# .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:
- requirements: docs/requirements.txt
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -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
Expand Down
8 changes: 4 additions & 4 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand All @@ -236,7 +236,7 @@
"index",
"BioBlend",
"BioBlend Documentation",
"Enis Afgan",
"Galaxy Project",
"BioBlend",
"One line description of project.",
"Miscellaneous",
Expand Down

0 comments on commit 67cbc56

Please sign in to comment.