docs: separate public manual from internal project documentation

2026-09-15 10:26:35 +02:00
parent 6a4634dcf1
commit 043ffdfad6
26 changed files with 859 additions and 238 deletions
@@ -7,6 +7,9 @@ on:
    paths:
      - "docs/**"
      - "mkdocs.yml"
+      - "scripts/build-docs.sh"
+      - "scripts/verify-public-docs.py"
+      - "scripts/test-verify-public-docs.py"
      - "docs/requirements.txt"
      - ".gitea/workflows/publish-docs.yml"
  workflow_dispatch:
@@ -34,14 +37,18 @@ jobs:
        with:
          python-version: "3.x"
          cache: pip
-          cache-dependency-path: docs/requirements.txt
+          cache-dependency-path: docs/requirements.lock

      - name: Install MkDocs dependencies
-        run: python -m pip install -r docs/requirements.txt
+        run: python -m pip install -r docs/requirements.lock
+
+      - name: Test public documentation boundary
+        run: python scripts/test-verify-public-docs.py

      - name: Build documentation
-        # Some documented source files intentionally live outside docs/.
-        run: mkdocs build
+        run: |
+          mkdocs build --strict
+          python scripts/verify-public-docs.py

      - name: Publish generated site to the pages branch
        working-directory: site