Repository navigation
docs: fix missing_docs and invalid-link errors (fix docs CI) - #41
Merged
ChrisRackauckas merged 1 commit intoJun 15, 2026
Merged
ChrisRackauckas merged 1 commit into
ChrisRackauckas merged 1 commit into
Conversation
The documentation build fails at the CheckDocument/CrossReferences stage with two pre-existing errors (both reproduce on a clean `main`): 1. `:missing_docs` -- five extension-point functions (`try_special_matrices`, `try_toeplitz`, `try_banded`, `try_blockbanded`, `try_almostbanded`) carry docstrings but are not referenced from any `@docs`/`@autodocs` block, while `make.jl` passes `modules = [SparseMatrixIdentification]`. Add an "Extension Point Functions" section to `docs/src/api.md` listing them. 2. `:cross_references` -- the `sparsestructure` docstring contains `[2, -1, -1] (requires SpecialMatrices)`, which Markdown parses as a link with text `2, -1, -1` and a nonexistent local destination `requires SpecialMatrices`. Wrap the pattern in backticks so it renders as inline code instead of a link. Verified locally on Julia 1.10.11: `makedocs` (linkcheck disabled for the offline run; that stage is unaffected) now completes without `:missing_docs` or `:cross_references` errors. On clean `main` the same build emits both errors. Runic leaves the edited source unchanged. Co-Authored-By: Chris Rackauckas <accounts@chrisrackauckas.com> Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
ChrisRackauckas
marked this pull request as ready for review
June 15, 2026 15:15
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.
Problem
The
docs / Build and Deploy Documentationcheck onmainis red.makedocsterminates at the CheckDocument/CrossReferences stage with two errors, both of which reproduce on a cleanmain::missing_docs— five extension-point functions (try_special_matrices,try_toeplitz,try_banded,try_blockbanded,try_almostbanded) carry docstrings but are not referenced from any@docs/@autodocsblock, whiledocs/make.jlpassesmodules = [SparseMatrixIdentification].:cross_references— thesparsestructuredocstring contains[2, -1, -1] (requires SpecialMatrices), which Markdown parses as a link with text2, -1, -1and a nonexistent local destinationrequires SpecialMatrices.(Only
:missing_docsis visible at the top of the CI log, but Documenter collects both error categories; both must be fixed for the build to go green.)Fix
docs/src/api.mdlisting the fivetry_*extension points.[2, -1, -1]in backticks in thesparsestructuredocstring so it renders as inline code rather than a link.Verification (local, Julia 1.10.11)
makedocs(linkcheck disabled for the offline run; that stage is independent of these two checks) now completes:with no
:missing_docsand no:cross_referenceserrors. On cleanmainthe same build emits:Runic leaves the edited source file unchanged.
Please ignore until reviewed by @ChrisRackauckas.