gh docs update

Author: yaroslav

.github/workflows/docs.yml

@@ -6,12 +6,10 @@ on:
   workflow_dispatch:
 
 permissions:
-  contents: read
-  pages: write
-  id-token: write
+  contents: write
 
 jobs:
-  build:
+  build-and-deploy:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
@@ -30,21 +28,12 @@ jobs:
       - name: Build HTML
         run: sphinx-build -b html docs/source docs/_build/html
 
-      - name: Upload artifact
-        uses: actions/upload-pages-artifact@v3
-        with:
-          path: docs/_build/html
+      - name: Disable Jekyll
+        run: touch docs/_build/html/.nojekyll
 
-  deploy:
-    needs: build
-    runs-on: ubuntu-latest
-    environment:
-      name: github-pages
-      url: ${{ steps.deployment.outputs.page_url }}
-    permissions:
-      pages: write
-      id-token: write
-    steps:
       - name: Deploy to GitHub Pages
-        id: deployment
-        uses: actions/deploy-pages@v4
+        uses: peaceiris/actions-gh-pages@v4
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: docs/_build/html
+          publish_branch: gh-pages

docs/README.md

@@ -24,3 +24,6 @@ Output appears in `docs/_build/html`. Open `index.html` in a browser to view.
 GitHub Pages can publish the docs via GitHub Actions (Source: GitHub Actions). After pushing to `main`, enable Pages in Repository Settings → Pages with Source set to GitHub Actions.
 
 The site uses the PyData Sphinx Theme (pulled in via `docs/requirements.txt`).
+
+To serve from the `gh-pages` branch (recommended for this workflow):
+Settings → Pages → Build and deployment → Source: Deploy from a branch → Branch: `gh-pages` / folder: `/ (root)`.