docs: repair strict cross-references - #4980
Draft
ChrisRackauckas-Claude wants to merge 1 commit into
Draft
Conversation
ChrisRackauckas-Claude
force-pushed
the
agent/fix-strict-doc-crossrefs
branch
from
August 16, 2026 13:38
64106bb to
0302915
Compare
Member
Author
|
Pushed Verification on the pushed tree:
|
ChrisRackauckas-Claude
force-pushed
the
agent/fix-strict-doc-crossrefs
branch
from
August 16, 2026 22:44
4be377a to
b325901
Compare
Co-Authored-By: Chris Rackauckas <accounts@chrisrackauckas.com>
ChrisRackauckas-Claude
force-pushed
the
agent/fix-strict-doc-crossrefs
branch
from
August 17, 2026 09:31
b325901 to
17b1a65
Compare
Member
Author
|
Rebased the docs-only strict cross-reference fix onto current master at Local verification: root ModelingToolkit QA |
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.
Ignore this PR until it has been reviewed by @ChrisRackauckas.
What changed
Strict Documenter exposed 34 unresolved cross-references on current
master.This PR keeps local ModelingToolkit references as qualified Documenter references, links dependency-owned APIs to their canonical SciML documentation, and renders internal-only helper names as code instead of pretending they are public documentation targets. It does not change behavior or public API.
Failure before
On the unmodified
f3248317cb51e08e78fb3d1729286905ad61d6d4base:DISPLAY=:0 JULIA_DEBUG=Documenter xvfb-run -a -s '-screen 0 1024x768x24' \ julia +lts --startup-file=no --project=docs/ --code-coverage=user docs/make.jlThe command exited 1, and:
The same failure is visible in the clean-master docs job:
https://github.com/SciML/ModelingToolkit.jl/actions/runs/31869817836/job/94981845495
A formal bisect of the strict cross-reference gate identified
92c27bb9fdcaa024ff190feb3d665452e33f9bd8(Adopt SciMLTesting 2.4 strict QA) as the first bad commit.Verification after
On this branch, based directly on
f3248317cb51e08e78fb3d1729286905ad61d6d4:DISPLAY=:0 JULIA_DEBUG=Documenter xvfb-run -a -s '-screen 0 1024x768x24' \ julia +lts --startup-file=no --project=docs/ --code-coverage=user docs/make.jlThe command still exits 1 for the independently tracked duplicate-doc and missing-doc failures, but the cross-reference discriminator is clean:
Both new canonical external links returned HTTP 200 during Documenter link checking.
Mechanical checks:
All three exited 0.
QA:
GROUP=QA julia +lts --startup-file=no --project -e 'using Pkg; Pkg.test()'The command reproduced the current-master ExplicitImports failure without a branch-specific regression:
GPU, downstream, Julia pre, and non-QA test groups were not run because this is a documentation-only change.