diff --git a/.readthedocs.yml b/.readthedocs.yml index 16a00cc7..3633731c 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -1,24 +1,35 @@ -# See: https://docs.readthedocs.io/en/latest/config-file/v2.html +# 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: python: "3.11" -# Build documentation in the docs/ directory with Sphinx +# Build documentation in the "docs/" directory with Sphinx + sphinx: - configuration: docs/conf.py + configuration: docs/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 -# 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 + - 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: - - method: pip - path: . - extra_requirements: - - docs + - requirements: docs/requirements.txt