diff --git a/.github/workflows/.readthedocs.yaml b/.github/workflows/.readthedocs.yaml new file mode 100644 index 0000000..c5ea964 --- /dev/null +++ b/.github/workflows/.readthedocs.yaml @@ -0,0 +1,33 @@ +# 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 OS, Python version and other tools you might need +build: + os: ubuntu-22.04 + tools: + python: "3.12" + # Uncomment and specify other tools if needed: + # nodejs: "20" + # rust: "1.70" + # golang: "1.20" + +# Build documentation in the "docs/" directory with Sphinx +sphinx: + configuration: docs/source/conf.py + # Use the dirhtml builder for cleaner URLs (optional) + builder: "dirhtml" + # Fail on all warnings to avoid broken references + fail_on_warning: true + +# Optionally build your docs in additional formats such as PDF and ePub +formats: + - pdf + - epub + +# Declare Python requirements needed to build your documentation +python: + install: + - requirements: docs/requirements.txt