Skip to content

Commit 58f48a8

Browse files
vinisalazarclaude
andcommitted
ci: build docs in strict mode on PRs/pushes
Add a docs job that runs `mkdocs build --strict` so broken links or missing pages fail CI on dev/main PRs. Deployment to GitHub Pages stays in docs.yml (main only). Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
1 parent 601b948 commit 58f48a8

1 file changed

Lines changed: 16 additions & 0 deletions

File tree

.github/workflows/python-app.yml

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,3 +61,19 @@ jobs:
6161
python -m pip install -e ".[dev,xarray]"
6262
- name: Run integration tests
6363
run: python -m pytest -m integration tests/
64+
65+
docs:
66+
# Build the documentation in strict mode so broken links or missing pages
67+
# fail the PR. Deployment to GitHub Pages stays in docs.yml (main only).
68+
runs-on: ubuntu-latest
69+
steps:
70+
- uses: actions/checkout@v4
71+
- uses: actions/setup-python@v5
72+
with:
73+
python-version: "3.12"
74+
- name: Install dependencies
75+
run: |
76+
python -m pip install --upgrade pip
77+
python -m pip install -e ".[docs]"
78+
- name: Build docs (strict)
79+
run: mkdocs build --strict

0 commit comments

Comments
 (0)