Update RTD build conditions (#412)

* update rtd yaml --------- Co-authored-by: Adam Dyess <[email protected]>
canonical · May 8, 2024 · 514e147 · 514e147
1 parent 0dd0ba2
commit 514e147
Showing 1 changed file with 12 additions and 1 deletion.
diff --git a/docs/tools/.readthedocs.yaml b/docs/tools/.readthedocs.yaml
@@ -9,8 +9,19 @@ version: 2
 build:
   os: ubuntu-22.04
   tools:
-    python: "3.11"
+    python: "3.12"
   jobs:
+    post_checkout:
+      # Cancel building pull requests when there aren't changed in the docs directory or YAML file.
+      #
+      # https://docs.readthedocs.io/en/latest/build-customization.html#cancel-build-based-on-a-condition
+      # 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 -- docs/ .readthedocs.yaml;
+        then
+          exit 183;
+        fi
     pre_build:
       - cp -r docs/src/* docs/tools/