CI: job to build docs from HEAD and compare to docs/book#636
Merged
Conversation
Build docs during CI to test if changes exist in `docs/src` that are missing from `docs/book`. Notes: - mdbook requires `PISA_BUILD_TOOLS=ON`: the docs job uses the build files from `test_cli` job - recursive diff the docs from the current build and those already checked in to HEAD under `docs/book` - pin mdbook v0.4.52 and cmdrun v0.7.3 so that HTML source changes do not affect the diff job; here pin means the versions are hardcoded in `.github/workflows/commit.yml` and `docs/README.md`
elshize
approved these changes
May 6, 2026
Member
|
Thanks @lgrz! |
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
2 participants
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.
Fixes #627 -- Check docs generation in CI.
Changes proposed in this pull request:
test_clijobdocs/book