Fix/doc linkcheck optional#104
Merged
Merged
Conversation
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
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.
Fix doc CI: make
mdbook-linkcheckpreprocessor optionalProblem
The
docCI job was failing with:docs/book.tomldeclares a[preprocessor.linkcheck]section, which requires the externalmdbook-linkcheckbinary at build time. The CI workflow only installsmdbook—mdbook-linkcheckwas never installed, causing the build to abort.Fix
Added
optional = trueto the[preprocessor.linkcheck]section indocs/book.toml. This instructs mdBook to skip the preprocessor gracefully whenmdbook-linkcheckis not present, rather than failing the build.Alternatives considered
mdbook-linkcheckin CI — would re-enable link checking in every build, butmdbook-linkcheckis currently unmaintained and may add fragility. Can be revisited separately.