up docs yml

Author: andreascaglioni

.github/workflows/deploy-docs.yml

@@ -2,59 +2,43 @@ name: "docs: build and deploy"
 
 on:
   push:
-    branches:
-      - main
-  workflow_dispatch: {}
+    branches: [ main ]
+  workflow_dispatch:
 
 permissions:
   contents: read
   pages: write
   id-token: write
 
 concurrency:
-  group: ${{ github.workflow }}-${{ github.ref }}
+  group: "pages"
   cancel-in-progress: true
 
 jobs:
-  build-and-deploy:
-    name: Build and publish Sphinx docs to GitHub Pages
+  build:
     runs-on: ubuntu-latest
-
     steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-
-      - name: Set up Python
-        uses: actions/setup-python@v5
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
         with:
-          python-version: '3.11'
-          cache: 'pip'
-
-      - name: Install dependencies
-        run: |
+          python-version: '3.12'
+      - run: |
           python -m pip install --upgrade pip
-          # install project and docs extras defined in pyproject.toml
           pip install -e ".[docs]"
-
       - name: Build Sphinx HTML
-        working-directory: docs
-        run: |
-          sphinx-build -b html -a -E -W -T . _build/html
-
-      - name: Upload pages artifact
-        uses: actions/upload-pages-artifact@v4
+        run: sphinx-build -b html docs docs/_build/html
+      - name: Upload Pages artifact
+        uses: actions/upload-pages-artifact@v3
         with:
-
           path: docs/_build/html
 
-  deploy-pages:
-    name: Deploy to GitHub Pages
-    needs: build-and-deploy
+  deploy:
+    needs: build
     runs-on: ubuntu-latest
-    permissions:
-      pages: write
-      id-token: write
-
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
     steps:
       - name: Deploy to GitHub Pages
-        uses: actions/deploy-pages@v1
+        id: deployment
+        uses: actions/deploy-pages@v4