fingers crossed

Author: rumbledethumps

.github/workflows/sphinx.yml

@@ -1,26 +1,32 @@
 name: Sphinx build
 
-on: push
+on:
+  push:
+    branches: [main]
 
 jobs:
   build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/configure-pages@v5
+      - name: Build HTML
+        run: |
+          pip install -r docs/requirements.txt
+          sphinx-build docs/source docs/build/html
+      - uses: actions/upload-pages-artifact@v3
+        with:
+          path: docs/build/html
+
+  deploy:
+    needs: build
     runs-on: ubuntu-latest
     permissions:
-      contents: write
+      pages: write
+      id-token: write
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
     steps:
-    - uses: actions/checkout@v4
-      with:
-        persist-credentials: false
-    - name: Build HTML
-      uses: ammaraskar/sphinx-action@master
-    - name: Upload artifacts
-      uses: actions/upload-artifact@v4
-      with:
-        name: html-docs
-        path: docs/build/html/
-    - name: Deploy
-      uses: peaceiris/actions-gh-pages@v3
-      if: github.ref == 'refs/heads/main'
-      with:
-        github_token: ${{ secrets.GITHUB_TOKEN }}
-        publish_dir: docs/build/html
+      - uses: actions/deploy-pages@v4
+        id: deployment

docs/requirements.txt

@@ -0,0 +1,2 @@
+Sphinx==8.2.3
+alabaster==1.0.0

docs/source/conf.py

@@ -14,8 +14,7 @@
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
 
-extensions = ['sphinx.ext.githubpages']
-
+extensions = []
 templates_path = ['_templates']
 exclude_patterns = []
 
@@ -27,7 +26,7 @@
 html_css_files = ['custom.css']
 html_theme_options = {
     'font_family': 'Arial, sans-serif',
-    # 'github_banner': True,
+    'github_banner': True,
     'github_user': 'picocomputer',
     'github_repo': '',
     'fixed_sidebar': False,