Docs Health #1
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Docs Health | |
| on: | |
| workflow_dispatch: | |
| schedule: | |
| - cron: "0 7 * * 1" | |
| jobs: | |
| docs-health: | |
| name: Build docs health report | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v6 | |
| - name: Set up uv | |
| uses: astral-sh/setup-uv@08807647e7069bb48b6ef5acd8ec9567f424441b | |
| with: | |
| python-version: "3.12" | |
| enable-cache: true | |
| - name: Install Qt EGL/XCB dependencies | |
| run: | | |
| sudo apt-get update | |
| sudo apt-get install -y --no-install-recommends \ | |
| libegl1 \ | |
| libgl1 \ | |
| libxkbcommon0 \ | |
| libdbus-1-3 | |
| - name: Sync docs + dev dependencies | |
| run: | | |
| uv sync --locked --dev --group docs | |
| - name: Generate docs health metrics | |
| env: | |
| QT_QPA_PLATFORM: offscreen | |
| MPLBACKEND: Agg | |
| run: | | |
| uv run python scripts/docs_health_report.py | |
| - name: Upload docs health report | |
| uses: actions/upload-artifact@v7 | |
| with: | |
| name: docs-health-${{ github.sha }} | |
| path: docs/_build/health | |
| if-no-files-found: error |