Skip to content

Fix/doc linkcheck optional#104

Merged
rex-schilasky merged 4 commits into
mainfrom
fix/doc-linkcheck-optional
Apr 7, 2026
Merged

Fix/doc linkcheck optional#104
rex-schilasky merged 4 commits into
mainfrom
fix/doc-linkcheck-optional

Conversation

@rex-schilasky
Copy link
Copy Markdown
Collaborator

Fix doc CI: make mdbook-linkcheck preprocessor optional

Problem

The doc CI job was failing with:

ERROR The command `mdbook-linkcheck` wasn't found, is the `linkcheck` preprocessor installed?
ERROR Unable to run the preprocessor `linkcheck`
    Caused by: No such file or directory (os error 2)

docs/book.toml declares a [preprocessor.linkcheck] section, which requires the external mdbook-linkcheck binary at build time. The CI workflow only installs mdbookmdbook-linkcheck was never installed, causing the build to abort.

Fix

Added optional = true to the [preprocessor.linkcheck] section in docs/book.toml. This instructs mdBook to skip the preprocessor gracefully when mdbook-linkcheck is not present, rather than failing the build.

Alternatives considered

  • Install mdbook-linkcheck in CI — would re-enable link checking in every build, but mdbook-linkcheck is currently unmaintained and may add fragility. Can be revisited separately.

@rex-schilasky rex-schilasky merged commit fe73efa into main Apr 7, 2026
7 checks passed
@rex-schilasky rex-schilasky deleted the fix/doc-linkcheck-optional branch April 7, 2026 18:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant