Fix master docs build: resolve upstream @ref cross-references (#879) - #881
Fix master docs build: resolve upstream @ref cross-references (#879)#881ChrisRackauckas-Claude wants to merge 2 commits into
Conversation
Fixes SciML#879. Documenter failed on master with [:cross_references] because bare `@ref` links inside upstream SciMLBase/OrdinaryDiffEq docstrings are spliced into this site via `@docs` without local targets: - Add `@docs` for SciMLBase.problem_type, OverrideInitData, ReturnCode, and reeval_internals_due_to_modification! so those bare refs resolve. - Rewrite copied OrdinaryDiffEq `[...](@ref Developer-Extension-API)` links to the published OrdinaryDiffEq public_api page before deleting `devtools/` (those pages cannot build inside DiffEqDocs). Co-Authored-By: Chris Rackauckas <accounts@chrisrackauckas.com>
4b7f442 to
b14b2d1
Compare
|
CI note (agent): Documentation workflow has Also rebased onto current This PR should still be ignored until reviewed by @ChrisRackauckas. |
Co-Authored-By: Chris Rackauckas <accounts@chrisrackauckas.com>
|
No fix the actual bad ref |
|
Closing in favor of source fixes rather than DiffEqDocs-side Bare Upstream PRs:
Once those land (and are registered / resolved by DiffEqDocs CI), master docs should go green without this PR. |
This PR should be ignored until reviewed by @ChrisRackauckas.
Fixes #879.
Problem
Master Documentation fails with
makedocs encountered an error [:cross_references]. Bare@refs live inside upstream SciMLBase / OrdinaryDiffEq docstrings spliced via@docswithout local targets.Broken refs (from run 29313032312):
problem_type,OverrideInitData,ReturnCode,reeval_internals_due_to_modification!(SciMLBase)Developer-Extension-API×3 (OrdinaryDiffEq API pages; target lives underdevtools/, which DiffEqDocs deletes)Fix
@docsentries for the four SciMLBase names in the appropriate local pages.devtools/, rewrite copied[...](@ref Developer-Extension-API)links to the published OrdinaryDiffEqpublic_apiURL.Does not add
:cross_referencestowarnonly.