More actions improvements

Author: Cleptomania

.github/workflows/code_quality.yml

@@ -40,77 +40,3 @@ jobs:
 
       - name: Type Checking (Pyright)
         run: uv run make.py pyright
-
-      # Prepare the Pull Request Payload artifact. If this fails,
-      # we fail silently using the `continue-on-error` option. It's
-      # nice if this succeeds, but if it fails for any reason, it
-      # does not mean that our lint-test checks failed.
-      - name: Prepare Pull Request Payload artifact
-        id: prepare-artifact
-        if: github.event_name == 'pull_request'
-        continue-on-error: true
-        run: cat $GITHUB_EVENT_PATH | jq '.pull_request' > pull_request_payload.json
-
-      # This only makes sense if the previous step succeeded. To
-      # get the original outcome of the previous step before the
-      # `continue-on-error` conclusion is applied, we use the
-      # `.outcome` value. This step also fails silently.
-      - name: Upload a Build Artifact
-        if: steps.prepare-artifact.outcome == 'success'
-        continue-on-error: true
-        uses: actions/upload-artifact@v4
-        with:
-          name: pull-request-payload
-          path: pull_request_payload.json
-
-  builddoc:
-
-    name: Documentation build test
-    runs-on: ${{ matrix.os }}
-
-    strategy:
-      matrix:
-        os: [ubuntu-latest]
-        # python-version in must be kept in sync with .readthedocs.yaml
-        python-version: ['3.10']  # July 2024 | Match our contributor dev version; see pyproject.toml
-        architecture: ['x64']
-
-    steps:
-      - uses: actions/checkout@v4
-      - name: setup
-        uses: actions/setup-python@v5
-        with:
-          python-version: ${{ matrix.python-version }}
-          architecture: ${{ matrix.architecture }}
-
-      - name: dependencies
-        run: |
-          python -m pip install -U pip wheel setuptools
-      - name: wheel
-        id: wheel
-        run: |
-          python -m pip install -e .[dev]
-      - name: build-docs
-        run: |
-          sphinx-build doc build -W
-      # Prepare the Pull Request Payload artifact. If this fails,
-      # we fail silently using the `continue-on-error` option. It's
-      # nice if this succeeds, but if it fails for any reason, it
-      # does not mean that our lint-test checks failed.
-      - name: Prepare Pull Request Payload artifact
-        id: prepare-artifact
-        if: always() && github.event_name == 'pull_request'
-        continue-on-error: true
-        run: cat $GITHUB_EVENT_PATH | jq '.pull_request' > pull_request_payload.json
-
-      # This only makes sense if the previous step succeeded. To
-      # get the original outcome of the previous step before the
-      # `continue-on-error` conclusion is applied, we use the
-      # `.outcome` value. This step also fails silently.
-      - name: Upload a Build Artifact
-        if: always() && steps.prepare-artifact.outcome == 'success'
-        continue-on-error: true
-        uses: actions/upload-artifact@v4
-        with:
-          name: pull-request-payload
-          path: pull_request_payload.json

.github/workflows/docs.yml

@@ -0,0 +1,33 @@
+# Builds the doc in PRs
+
+on:
+  push:
+    branches: [development, maintenance]
+  pull_request:
+    branches: [development, maintenance]
+  workflow_dispatch:
+
+jobs:
+
+  build:
+    name: Build Documentation
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v5
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.10'
+
+      - name: Install UV
+        uses: astral-sh/setup-uv@v7
+        with:
+          enable-cache: true
+
+      - name: Sync UV Project
+        run: uv sync
+
+      - name: build-docs
+        run: uv run make.py docs-full

make.py

@@ -207,6 +207,16 @@ def serve():
     )
 
 
+@app.command(rich_help_panel="Docs")
+def docs_full():
+    """
+    Build the documentation fully and error on warnings. This is what is checked in CI.
+    """
+    run_doc([SPHINX_BUILD, DOC_DIR, "build", "-W"])
+    print()
+    print("Build finished")
+
+
 @app.command(rich_help_panel="Docs")
 def linkcheck():
     """