ci: skip doc build on draft PRs

readthedocs.yml → .readthedocs.yml

@@ -1,11 +1,25 @@
+# Read the Docs configuration file for Sphinx projects
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
 version: 2
 
 build:
-  os: ubuntu-22.04
+  os: ubuntu-24.04
   tools:
-    python: "3.10"
+    python: "3.14"
   jobs:
     post_checkout:
+      # Skip builds for draft pull requests (exit code 183 cancels the build)
+      # See https://docs.readthedocs.com/platform/en/stable/guides/build/skip-build.html
+      - |
+        if [ "$READTHEDOCS_VERSION_TYPE" = "external" ]; then
+          DRAFT=$(curl -s "https://api.github.com/repos/CS-SI/eodag/pulls/${READTHEDOCS_VERSION}" | python3 -c "import sys, json; print(json.load(sys.stdin).get(\"draft\", False))")
+          if [ "$DRAFT" = "True" ]; then
+            exit 183;
+          fi
+        fi
+      # fetch repo
       - git fetch --unshallow
       - git config remote.origin.fetch "+refs/heads/*:refs/remotes/origin/*"
       - git fetch origin

CONTRIBUTING.rst

@@ -43,6 +43,9 @@ We use ``prek`` (faster ``pre-commit``) to run a suite of linters, formatters an
 , ``flake8``) to ensure the code base is homogeneously formatted and easier to read. It's important that you install it,
 since we run the exact same hooks in the Continuous Integration.
 
+The default branch for development is `develop`. Please create your new branch from `develop` to work on your patch, and open a pull request against `develop` when you are done.
+If you do not have permissions to push to the main repository, you can fork it and push your branch to your forked repository. Then, you can open a pull request against the main repository.
+
 To run the default test suite (which excludes end-to-end tests):
 
 .. code-block:: bash
@@ -122,6 +125,12 @@ If not, the outputs and the widgets (e.g. progress bar) won't be displayed in th
 `Read the Docs <https://readthedocs.org/>`_ is a service that uses Sphinx to build a documentation website,
 which it then hosts for free for open source projects, such as EODAG.
 
+.. note::
+
+    Documentation preview builds are triggered on pull requests, and are available in the generated "Checks" pannel at
+    the bottom of the pull request conversation.
+    Draft pull requests are not built to save build time and resources.
+
 Release EODAG
 -------------