octoleo
/
restic
mirror of https://github.com/octoleo/restic.git
2
2
Fork 0
Code Issues Releases Wiki Activity

Remove readthedocs special case from docs configuration 

Apparently it's now required to bring your own theme.
This commit is contained in:
Michael Eischer 2023-10-26 21:02:35 +02:00
parent 826d880614
commit 69dec02a14
2 changed files with 14 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
.readthedocs.yaml
View File

@ -13,6 +13,6 @@ sphinx:
configuration: doc/conf.py configuration: doc/conf.py
# https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html # https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
# python: python:
# install: install:
# - requirements: docs/requirements.txt - requirements: doc/requirements.txt

30
doc/conf.py
View File

@ -12,14 +12,16 @@
# #
# All configuration values have a default; values that are commented out # All configuration values have a default; values that are commented out
# serve to show the default. # serve to show the default.
import os
# -- General configuration ------------------------------------------------ # -- General configuration ------------------------------------------------
# Add any Sphinx extension module names here, as strings. They can be # Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones. # ones.
extensions = ['sphinx.ext.extlinks'] extensions = [
'sphinx.ext.extlinks',
'sphinx_rtd_theme',
]
# Add any paths that contain templates here, relative to this directory. # Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates'] templates_path = ['_templates']
@ -35,7 +37,7 @@ master_doc = 'index'
# General information about the project. # General information about the project.
project = 'restic' project = 'restic'
copyright = '2018, restic authors' copyright = '2023, restic authors'
author = 'fd0' author = 'fd0'
# The version info for the project you're documenting, acts as replacement for # The version info for the project you're documenting, acts as replacement for
@ -54,7 +56,7 @@ release = version
# #
# This is also used if you do content translation via gettext catalogs. # This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases. # Usually you set "language" from the command line for these cases.
language = None language = "en"
# List of patterns, relative to source directory, that match files and # List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files. # directories to ignore when looking for source files.
@ -72,21 +74,11 @@ todo_include_todos = False
# The theme to use for HTML and HTML Help pages. See the documentation for # The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes. # a list of builtin themes.
# html_theme = 'sphinx_rtd_theme'
if os.environ.get('READTHEDOCS') == 'True':
html_context = { html_css_files = [
'css_files': [ 'css/restic.css',
'https://media.readthedocs.org/css/sphinx_rtd_theme.css', ]
'https://media.readthedocs.org/css/readthedocs-doc-embed.css',
'_static/css/restic.css',
]
}
else:
# we're not built by rtd => add rtd-theme
import sphinx_rtd_theme
html_theme = 'sphinx_rtd_theme'
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
html_style = 'css/restic.css'
html_logo = 'logo/logo.png' html_logo = 'logo/logo.png'