diff --git a/.readthedocs.yaml b/.readthedocs.yaml index df3d6c32..3a772387 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -1,12 +1,10 @@ ---- -# .readthedocs.yaml -# Read the Docs configuration file +# Read the Docs configuration file for Sphinx projects # See https://docs.readthedocs.io/en/stable/config-file/v2.html for details # Required version: 2 -# Set the version of Python and other tools you might need +# Set the OS, Python version and other tools you might need build: os: ubuntu-22.04 tools: @@ -16,15 +14,17 @@ build: # rust: "1.64" # golang: "1.19" -# Build documentation in the docs/ directory with Sphinx +# Build documentation in the "docs/" directory with Sphinx sphinx: configuration: docs/conf.py - -# If using Sphinx, optionally build your docs in additional formats such as PDF +# Optionally build your docs in additional formats such as PDF and ePub # formats: # - pdf +# - epub -# Optionally declare the Python requirements required to build your docs +# 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