summaryrefslogtreecommitdiffstats
path: root/.readthedocs.yml
diff options
context:
space:
mode:
Diffstat (limited to '.readthedocs.yml')
-rw-r--r--.readthedocs.yml14
1 files changed, 14 insertions, 0 deletions
diff --git a/.readthedocs.yml b/.readthedocs.yml
index 898a9ae..59830c7 100644
--- a/.readthedocs.yml
+++ b/.readthedocs.yml
@@ -13,6 +13,20 @@ build:
python: "3"
commands:
+ # https://docs.readthedocs.io/en/stable/build-customization.html#cancel-build-based-on-a-condition
+ #
+ # Cancel building pull requests when there aren't changes in the Doc 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.yml; echo $?)" -eq 0 ];
+ then
+ echo "No changes to Doc/ - exiting the build.";
+ exit 183;
+ fi
+
- make -C Doc venv html
- mkdir _readthedocs
- mv Doc/build/html _readthedocs/html
+