try build gallery and send to rtd again

kushalkolar · kushalkolar · commit 73f37d700345 · 2024-10-06T06:57:42.000-04:00
diff --git a/.github/workflows/build-gallery.yml b/.github/workflows/build-gallery.yml
@@ -0,0 +1,44 @@
+name: Docs
+on: [push, release]
+
+jobs:
+  notebooks:
+    name: "Build the notebooks for the docs"
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          lfs: true
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: 3.11
+      - name: Install llvmpipe and lavapipe for offscreen canvas
+        run: |
+          sudo apt-get update -y -qq
+          sudo apt-get install --no-install-recommends -y ffmpeg libegl1-mesa libgl1-mesa-dri libxcb-xfixes0-dev mesa-vulkan-drivers git-lfs
+      - name: Install dev dependencies
+        run: |
+          python -m pip install --upgrade pip setuptools
+          # remove pygfx from install_requires, we install using pygfx@main
+          sed -i "/pygfx/d" ./setup.py
+          pip install git+https://github.com/pygfx/pygfx.git@main
+          pip install -e ".["tests"]"
+      - name: Show wgpu backend
+        run:
+          python -c "from examples.tests.testutils import wgpu_backend; print(wgpu_backend)"
+      - name: make gallery
+        run: |
+          RTD_BUILD=1 sphinx-build -b dummy source/ /tmp/
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: gallery-${{ github.sha }}
+          path: docs/source/_gallery
+
+      - name: Trigger RTDs build
+        uses: dfm/rtds-action@v1
+        with:
+          webhook_url: ${{ secrets.RTDS_WEBHOOK_URL }}
+          webhook_token: ${{ secrets.RTDS_WEBHOOK_TOKEN }}
+          commit_ref: ${{ github.ref }}
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -44,9 +44,28 @@
     "sphinx.ext.viewcode",
     "sphinx_copybutton",
     "sphinx_design",
-    "sphinx_gallery.gen_gallery"
+    "sphinx_gallery.gen_gallery",
+    "rtds_action",
 ]
 
+# The name of your GitHub repository
+rtds_action_github_repo = "fastplotlib/fastplotlib"
+
+# The path where the artifact should be extracted
+# Note: this is relative to the conf.py file!
+rtds_action_path = "_gallery"
+
+# The "prefix" used in the `upload-artifact` step of the action
+rtds_action_artifact_prefix = "gallery-"
+
+# A GitHub personal access token is required, more info below
+rtds_action_github_token = os.environ["GITHUB_TOKEN"]
+
+# Whether or not to raise an error on Read the Docs if the
+# artifact containing the notebooks can't be downloaded (optional)
+rtds_action_error_if_missing = False
+
+
 sphinx_gallery_conf = {
     "gallery_dirs": "_gallery",
     "backreferences_dir": "_gallery/backreferences",
diff --git a/setup.py b/setup.py
@@ -15,6 +15,7 @@
         "sphinx",
         "sphinx-gallery",
         "furo",
+        "rtds-action",
         "glfw",
         "jupyter-rfb>=0.4.1",  # required so ImageWidget docs show up
         "ipywidgets>=8.0.0,<9",
