fix RTD build

.github/workflows/docs.yml

@@ -23,14 +23,15 @@ jobs:
   test-getting_started:
     uses: ./.github/workflows/run-rp-notebook.yml
     with:
-      python-version: 3.9
+      python-version: 3.12
       requirements-file: 'requirements-docs-ci.txt'
       notebook-name: 'getting_started.ipynb'
 
   test-tutorials:
     strategy:
       matrix:
         tutorial: [
+          # FIXME: *.ipynb
           'configuration.ipynb',
           'debugging.ipynb',
           'describing_tasks.ipynb',
@@ -43,8 +44,16 @@ jobs:
         ]
     uses: ./.github/workflows/run-rp-notebook.yml
     with:
-      python-version: 3.9
+      python-version: 3.12
       requirements-file: 'requirements-docs-ci.txt'
       notebook-name: ${{ matrix.tutorial }}
       notebook-path: 'tutorials'
 
+# build-docs: # FIXME...
+#   # runs on VM1
+#   # sphinx w/o notebooks
+#
+# commit-notebooks: # FIXME...
+#   # runs on VM2
+#   # sphinx w/o notebooks
+

.github/workflows/rtd.yml

@@ -0,0 +1,77 @@
+name: 'Build RTD'
+
+on:
+  push:
+    branches:
+      - 'devel*'
+  pull_request:
+    branches:
+      - 'devel*'
+      - 'master*'
+
+# This allows a subsequently queued workflow run to interrupt previous runs
+concurrency:
+  group: '${{ github.workflow }} @ ${{ github.event.pull_request.head.label || github.head_ref || github.ref }}'
+  cancel-in-progress: true
+
+jobs:
+  rtd:
+    name: "Build documentation"
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Set up Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.12
+
+      - name: Install dependencies
+        run: |
+          sudo apt update
+          sudo apt install -y pandoc
+          sudo apt install -y libopenmpi-dev
+          sudo apt install -y texlive cm-super
+          sudo apt install -y texlive-fonts-extra texlive-extra-utils dvipng
+          sudo apt install -y texlive-fonts-recommended texlive-latex-extra
+          python -m pip install -U pip
+          python -m pip install -r requirements-docs-ci.txt
+
+      - name: Build the docs
+        run: |
+          export RADICAL_LOG_LVL=DEBUG
+          export RADICAL_BASE=`pwd`
+          # FIXME: magic rm / empty all cells
+          sphinx-build -M html docs/source docs/build
+          cp -R docs/build/*ipy docs/source
+
+      - name: Collect artifacts
+        if: always()
+        run: |
+          mkdir doc_artifacts/
+          cp -R ./docs doc_artifacts/
+          cp -R ./rp.sess* doc_artifacts/
+          cp -R /home/runner/radical.pilot.sandbox doc_artifacts/
+
+      - name: Upload doc artifacts
+        if: always()
+        uses: actions/upload-artifact@v4
+        with:
+            name: doc_artifacts
+            path: doc_artifacts
+            retention-days: 5
+
+      - name: Upload to RTD
+        uses: actions/upload-artifact@v4
+        if: always()
+        with:
+          name: rtd-${{ github.sha }}
+          path: docs/build
+
+      - name: Trigger RTDs build
+        uses: dfm/rtds-action@v1
+        with:
+          webhook_url:   ${{ secrets.RTD_URL }}
+          webhook_token: ${{ secrets.RTD_TOKEN }}
+          commit_ref:    ${{ github.ref }}
+

docs/source/conf.py

@@ -4,6 +4,8 @@
 # list see the documentation:
 # https://www.sphinx-doc.org/en/master/usage/configuration.html
 
+import os
+
 # -- Path setup --------------------------------------------------------------
 
 # If extensions (or modules to document with autodoc) are in another directory,
@@ -56,6 +58,13 @@
     'myst_parser'
 ]
 
+
+github_token = os.environ.get("GITHUB_TOKEN")
+
+if github_token:
+    extensions.append('rtds_action')
+
+
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
 # The suffix(es) of source filenames.
@@ -120,3 +129,12 @@
 # napoleon_preprocess_types = False
 # napoleon_type_aliases = None
 # napoleon_attr_annotations = True
+
+# -- rtds settings -------------------------------------------------------------
+# The "prefix" used in the `upload-artifact` step of the action
+if github_token:
+    rtds_action_github_repo      = "radical-cybertools/radical.pilot"
+    rtds_action_github_token     = github_token
+    rtds_action_artifact_prefix  = "rtd-"
+    rtds_action_error_if_missing = False
+

docs/source/process/release_procedure.rst

@@ -62,7 +62,7 @@ That last step is hard to automate as it involves resolving conflicts in all bra
 
 
 Preparing a hotfix release
--------------------------
+--------------------------
 
 1. Create branch from latest master: e.g. ``git checkout master; git pull; git
    checkout -b hotfix/issue_123``;
@@ -71,8 +71,8 @@ Preparing a hotfix release
    abcsuperdupercommit890`` (The latter is preferred);
 4. update release notes: ``$EDITOR CHANGES.md``;
 5. commit and push: ``git commit -a; git push``;
-6. create `pull-request <https://github.com/radical-cybertools/radical.pilot/pulls>`__
-   of hotfix branch to master;
+6. create `pull-request <https://github.com/radical-cybertools/radical.pilot/pulls>`__ of hotfix
+    branch to master;
 7. wait on and/or nudge other developer to review and test;
 8. if not approved, ``GOTO 3``.
 

requirements-docs.txt

@@ -11,6 +11,8 @@ python-dotenv[cli]
 sphinx_copybutton
 sphinx_rtd_theme>=0.5.1
 myst_parser
+docutils
+rtds_action
 docutils==0.17.1
 mpi4py
 

src/radical/pilot/task_description.py

@@ -717,9 +717,9 @@ class TaskDescription(FastTypedDict):
 
     # --------------------------------------------------------------------------
     #
-    def __init__(self, from_dict=None):
+    def __init__(self, from_dict=None, **kwargs):
 
-        super().__init__(from_dict=from_dict)
+        super().__init__(from_dict=from_dict, **kwargs)
 
 
     # --------------------------------------------------------------------------

tests/workflows/bridges.yml

@@ -26,10 +26,10 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v2
-    - name: Set up Python 3.7
+    - name: Set up Python 3.8
       uses: actions/setup-python@v2
       with:
-        python-version: 3.7
+        python-version: 3.8
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip

tests/workflows/summit.yml

@@ -26,10 +26,10 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v2
-    - name: Set up Python 3.7
+    - name: Set up Python 3.8
       uses: actions/setup-python@v2
       with:
-        python-version: 3.7
+        python-version: 3.8
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip