diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000..daf79f7 --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,41 @@ +# .readthedocs.yaml +# Read the Docs configuration file +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + +# Required +version: 2 + +# Build documentation in the docs/ directory with Sphinx +sphinx: + configuration: docs/source/conf.py + +# Optionally build your docs in additional formats such as PDF +formats: + - pdf + +# Configure how to build the docs +build: + os: ubuntu-22.04 + apt_packages: + - graphviz + tools: + python: "3.11" + jobs: + post_checkout: + # https://docs.readthedocs.io/en/stable/build-customization.html#cancel-build-based-on-a-condition + # + # Cancel building pull requests when there aren't changed in the docs directory. + # + # If there are no changes (git diff exits with 0) we force the command to return with 183. + # This is a special exit code on Read the Docs that will cancel the build immediately. + - | + if [ "$READTHEDOCS_VERSION_TYPE" = "external" ] && git diff --quiet origin/main -- doc/ .readthedocs.yaml; + then + echo "No changes to docs/ - exiting the build."; + exit 183; + fi + +# Optionally set the version of Python and requirements required to build your docs +python: + install: + - requirements: docs/requirements.txt