diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 3a73b5a3c..04275ce72 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -4,7 +4,7 @@ # Required version: 2 -# Set the OS, Python version and other tools you might need +# Set the OS, Python version and other tools you might need. build: os: ubuntu-22.04 tools: @@ -14,22 +14,24 @@ build: # rust: "1.70" # golang: "1.20" -# Build documentation in the "docs/" directory with Sphinx +# Build documentation in the "doc/" directory with Sphinx. sphinx: configuration: doc/source/conf.py # You can configure Sphinx to use a different builder, for instance use the dirhtml builder for simpler URLs # builder: "dirhtml" # Fail on all warnings to avoid broken references - # fail_on_warning: true + fail_on_warning: true -# Optionally build your docs in additional formats such as PDF and ePub +# Optionally build your docs in additional formats such as PDF and ePub. # formats: -# - pdf -# - epub +# - pdf +# - epub # Optional but recommended, declare the Python requirements required -# to build your documentation +# to build your documentation. # See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html -# python: -# install: -# - requirements: docs/requirements.txt +python: + install: + - method: pip + path: . + - requirements: doc/requirements.txt diff --git a/doc/source/conf.py b/doc/source/conf.py index ea7a28291..9c22ca06a 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -93,7 +93,7 @@ # Options for HTML output # ----------------------- -# html_theme = "sphinx_rtd_theme" +html_theme = "sphinx_rtd_theme" html_theme_options = {} # The name for this set of Sphinx documents. If None, it defaults to