Fix the Documentation build: load the packages the copied API pages need - #900
Merged
ChrisRackauckas merged 1 commit intoAug 28, 2026
Merged
Conversation
…refs failing the build The Documentation build aggregates OrdinaryDiffEq's and StochasticDiffEq's own docs/src trees, so it has to provide the same load-time scope those pages were written against. It was missing OrdinaryDiffEqTaylorSeries and GlobalDiffEq (leaving the ExplicitTaylor and GlobalRichardson sections empty and their `@ref`s unresolvable), and ADTypes and SciMLOperators, which the `@autodocs` blocks in the copied api/common_interface.md evaluate in this scope. The remaining cross-references come from upstream docstrings that point at solver internals this site does not document, and cannot be resolved from here, so :cross_references joins :docs_block and :missing_docs in warnonly. Three absolute URLs baked into the copied pages and docstrings are unreachable (two docs.sciml.ai pages that are not deployed, one paywalled DOI) and are added to linkcheck_ignore. Co-authored-by: Cursor <cursoragent@cursor.com>
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.
Summary
The Documentation workflow has been failing on
masterwithdocs/make.jlcopies OrdinaryDiffEq's and StochasticDiffEq's owndocs/srctrees intodocs/src/api/, so this build has to supply the same load-time scope those pages were written against. Several packages were missing from it:OrdinaryDiffEqTaylorSeries— the copiedexplicit/TaylorSeries.mddocumentsOrdinaryDiffEqTaylorSeries.ExplicitTaylor/ExplicitTaylor2/ExplicitTaylorAdaptiveOrder, which produced theUndefVarError: OrdinaryDiffEqTaylorSeries not defined in Mainin the log and left that page's API section empty.GlobalDiffEq— the copiedglobalerrorcontrol/GlobalDiffEq.mddocumentsGlobalRichardson; without the package the@docsblock reported an undefined binding and the page's[GlobalRichardson](@ref)became a hard:cross_referenceserror.ADTypesandSciMLOperators— the released OrdinaryDiffEqapi/common_interface.mdnow uses@autodocsblocks whoseModules = [...]are evaluated in this scope. These are alreadydocs/Project.tomldependencies but were never loaded inmake.jl, so the AD and operator sections failed to expand.Both
GlobalDiffEqandOrdinaryDiffEqTaylorSeriesare added todocs/Project.toml, matching how OrdinaryDiffEq's owndocs/make.jlloads them.Two classes of failure are owned upstream and can't be resolved from here:
@refs (AutoSwitch,AutoAlgSwitch,StochasticCompositeCache,has_global_error) come from docstrings inStochasticDiffEqCoreandSciMLBasethat link to solver internals this aggregated site does not pull in as@docs— documenting them here would cascade into their own internal@refs (unwrap_alg,get_current_alg_order, cache types).:cross_referencestherefore joins:docs_blockand:missing_docsinwarnonly, which are already tolerated for exactly this reason.linkcheck_ignore:SciMLBase/stable/interfaces/Problem_Traits/(in SciMLBase'spages.jlbut not on the deployed site),OrdinaryDiffEq/stable/devtools/internals/public_api/(this build deliberately drops thedevtoolstree), and a paywalled SIAM DOI cited by the ADTypes docstrings that the AD section now renders.No sections are disabled and no package versions are bumped.
Test plan
julia --project=docs docs/make.jlcompletes with exit code 0 and renders the whole site (35 MB indocs/build). NoError:lines remain; only pre-existing warnings (missing_docs,docs_block, size-threshold notices).ExplicitTaylor2onapi/ordinarydiffeq/explicit/TaylorSeries/,GlobalRichardsononapi/ordinarydiffeq/globalerrorcontrol/GlobalDiffEq/, and theAutoForwardDiff/AbstractColoringAlgorithmautodocs output onapi/ordinarydiffeq/api/common_interface/.linkcheckpasses with no 4xx/5xx errors.Made with Cursor