ci

Author: afuetterer

.github/workflows/documentation.yml

@@ -8,11 +8,8 @@ on:
   # Allows you to run this workflow manually from the Actions tab
   workflow_dispatch:
 
-# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
-permissions:
-  contents: write
-  pages: write
-  id-token: write
+# Set permissions at the job level.
+permissions: {}
 
 # Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
 # However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
@@ -21,7 +18,6 @@ concurrency:
   cancel-in-progress: false
 
 jobs:
-  # Build documentation, upload html
   # permissions: upload
   build:
     runs-on: ubuntu-slim
@@ -30,48 +26,45 @@ jobs:
       - uses: actions/setup-python@v6
         with:
           python-version: "3.14"
+          cache: 'pip'
+
       - run: |
           python -m pip install --upgrade pip
           python -m pip install . --group=docs
           python -m pip list
+
       - run: |
           sphinx-build --builder html docs/source/ docs/build/html
 
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v4
+        with:
+          name: docs-html
+          path: './docs/build/html'
+
   deploy:
-    # permissions: upload, pages
+    needs: build
+    # Deploy only on push to master
+    if: github.event_name == 'push' && github.ref == 'refs/heads/master'
+    permissions:
+      pages: write
+      id-token: write
     environment:
       name: github-pages
       url: ${{ steps.deployment.outputs.page_url }}
-    # TODO: ubuntu slim enough?
     runs-on: ubuntu-slim
-    # download html
     steps:
-      - uses: actions/checkout@v6
-      - uses: actions/setup-python@v6
+      - name: Download HTML artifact
+        uses: actions/download-artifact@v4
         with:
-          python-version: "3.14"
-      - run: |
-          python -m pip install --upgrade pip
-          python -m pip install . --group=docs
-
-      # TODO: This gets included in docs/conf.py
-
-      # - name: Sphinx APIDoc
-      #   run: |
-      #     sphinx-apidoc --force -o docs/source/ .
-      - name: Sphinx build
-        run: |
-          sphinx-build --builder html docs/source/ docs/build/html
-
-      # # TODO: From here only on master branch
-
-      # - name: Setup Pages
-      #   uses: actions/configure-pages@v5
-      # - name: Upload artifact
-      #   uses: actions/upload-pages-artifact@v4
-      #   with:
-      #     # Upload entire repository
-      #     path: './docs/build/html'
-      # - name: Deploy to GitHub Pages
-      #   id: deployment
-      #   uses: actions/deploy-pages@v4
+          name: docs-html
+          path: docs/build/html
+      - name: Setup Pages
+        uses: actions/configure-pages@v5
+      - name: Upload Pages artifact
+        uses: actions/upload-pages-artifact@v4
+        with:
+          path: docs/build/html
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4