ci: add mkdocs --strict docs build as a required check#215
Merged
Conversation
Adds a 'docs-build' just recipe (uvx + docs/requirements.txt, mkdocs build --strict) and a 'docs' job to the reusable _checks workflow, so broken links, missing nav entries, and config errors fail CI on every PR. CI previously only ran lint + pytest and never built the docs, so the recent admonition-extension regression (#214) would not have been caught. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
lesnik512
force-pushed
the
ci-docs-strict-build
branch
from
cd11907 to
4d248ba
Compare
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Adds docs-build verification to CI so documentation breakage fails the build.
just docs-buildrecipe:uvx --with-requirements docs/requirements.txt mkdocs build --strict(mirrorsdocs-deploy).docsjob in the reusable.github/workflows/_checks.yml, so it runs on every PR/push (viaci.yml) and in the weekly scheduled dep-check (viascheduled.yml).Why
CI ran only
lint+pytestand never built the docs. The site-wide admonition-rendering regression fixed in #214 (and any future broken link / missing nav entry / bad mkdocs config) would pass CI undetected.--strictturns those into build failures.Verification
just docs-buildpasses locally (exit 0).docsjob.🤖 Generated with Claude Code