docs: repair strict cross-references - #4980
Conversation
64106bb to
0302915
Compare
|
Pushed Verification on the pushed tree:
|
b325901 to
17b1a65
Compare
|
Rebased the docs-only strict cross-reference fix onto current master at Local verification: root ModelingToolkit QA |
Co-Authored-By: Chris Rackauckas <accounts@chrisrackauckas.com>
17b1a65 to
b6b9f8d
Compare
|
Rebased this PR onto current master 29f589e. Runic, added-line typos, and git diff --check passed. The docs environment was instantiated successfully and the full docs build completed doctests, template expansion, cross-reference construction, and document checks before stopping only on GitHub NEWS.md HTTP 429 during external link checking; Claytex and codecov redirects were warnings. The focused InterfaceI test was run locally after the rebase; its final result will be recorded once the active process completes. |
|
The focused InterfaceI verification has completed on the rebased head: Test Summary reports 1,487 passed, 3 broken, 1,490 total in 49m11.4s, followed by Testing ModelingToolkit tests passed. The three broken cases are existing expected broken tests; no branch-specific test failure was reported. |
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.