diff --git a/.readthedocs.yml b/.readthedocs.yml index 6b845b6..fcd2c91 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -1,24 +1,33 @@ -# .readthedocs.yml -# 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 +version: 2 -# Build documentation in the sp-aslkpro/ directory with Sphinx -sphinx: - configuration: sp-aslkpro/conf.py +# Set the OS, Python version and other tools you might need +build: + os: ubuntu-22.04 + tools: + python: "3.12" + # You can also specify other tool versions: + # nodejs: "20" + # rust: "1.70" + # golang: "1.20" -# Build documentation with MkDocs -# mkdocs: -# configuration: mkdocs.yml +# Build documentation in the "docs/" directory with Sphinx +sphinx: + 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 -# 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 +# - epub # Optionally set the version of Python and requirements required to build your docs python: - version: 3.8 install: - requirements: sp-aslkpro/requirements.txt