diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000000..773d340b3e --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,28 @@ +version: 2 + +sphinx: + builder: html + configuration: docs/source/conf.py + fail_on_warning: true + +build: + os: ubuntu-22.04 + tools: + python: "3.11" + jobs: + post_checkout: + # Cancel building pull requests when there aren't changed in the docs directory or YAML file. + # You can add any other files or directories that you'd like here as well, + # like your docs requirements file, or other files that will change your docs build. + # + # 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/master -- docs/ docs/.readthedocs.yaml; + then + exit 183; + fi + +python: + install: + - requirements: docs/requirements.txt diff --git a/docs/.readthedocs.yml b/docs/.readthedocs.yml deleted file mode 100644 index 3b80b77b96..0000000000 --- a/docs/.readthedocs.yml +++ /dev/null @@ -1,15 +0,0 @@ -version: 2 - -sphinx: - builder: html - configuration: source/conf.py - fail_on_warning: true - -build: - os: ubuntu-22.04 - tools: - python: "3.11" - -python: - install: - - requirements: requirements.txt