Skip to content

Fix the Documentation build: load the packages the copied API pages need #900

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ChrisRackauckas merged 1 commit into from
Aug 28, 2026
Merged

Fix the Documentation build: load the packages the copied API pages need #900

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/Project.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ Distributions = "31c24e10-a181-5473-b8eb-7969acd0382f"
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
FiniteDiff = "6a86dc24-6348-571c-b903-95158fe2bd41"
ForwardDiff = "f6369f11-7733-5829-9624-2563aa707210"
GlobalDiffEq = "1d72d19b-84cc-4cb7-a099-7cbdb9ccc67c"
ImplicitDiscreteSolve = "3263718b-31ed-49cf-8a0f-35a466e8af96"
IncompleteLU = "40713840-3770-5561-ab4c-a76e7d0d7895"
JLD2 = "033835bb-8acc-5ee8-8aae-3f567f8a3819"
Expand Down Expand Up @@ -67,6 +68,7 @@ OrdinaryDiffEqSSPRK = "669c94d9-1f4b-4b64-b377-1aa079aa2388"
OrdinaryDiffEqStabilizedIRK = "e3e12d00-db14-5390-b879-ac3dd2ef6296"
OrdinaryDiffEqStabilizedRK = "358294b1-0aab-51c3-aafe-ad5ab194a2ad"
OrdinaryDiffEqSymplecticRK = "fa646aed-7ef9-47eb-84c4-9443fc8cbfa8"
OrdinaryDiffEqTaylorSeries = "9c7f1690-dd92-42a3-8318-297ee24d8d39"
OrdinaryDiffEqTsit5 = "b1df2697-797e-41e3-8120-5422d3b24e4a"
OrdinaryDiffEqVerner = "79d7bb75-1356-48c1-b8c0-6832512096c2"
Plots = "91a5bcdd-55d7-5caf-9e0b-520d859cae80"
Expand Down Expand Up @@ -126,6 +128,7 @@ Distributions = "0.25"
Documenter = "1"
FiniteDiff = "2"
ForwardDiff = "0.10, 1"
GlobalDiffEq = "1.2.1"
ImplicitDiscreteSolve = "2"
IncompleteLU = "0.2"
JLD2 = "0.4, 0.5.1, 0.6"
Expand Down Expand Up @@ -165,6 +168,7 @@ OrdinaryDiffEqSSPRK = "2"
OrdinaryDiffEqStabilizedIRK = "2"
OrdinaryDiffEqStabilizedRK = "2"
OrdinaryDiffEqSymplecticRK = "2"
OrdinaryDiffEqTaylorSeries = "2"
OrdinaryDiffEqTsit5 = "2"
OrdinaryDiffEqVerner = "2"
Plots = "1"
Expand Down
26 changes: 25 additions & 1 deletion docs/make.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,14 @@ using OrdinaryDiffEqAdamsBashforthMoulton, OrdinaryDiffEqDefault, OrdinaryDiffEq
OrdinaryDiffEqRosenbrock, OrdinaryDiffEqSDIRK, OrdinaryDiffEqSSPRK,
OrdinaryDiffEqStabilizedIRK, OrdinaryDiffEqStabilizedRK, OrdinaryDiffEqSymplecticRK,
OrdinaryDiffEqTsit5, OrdinaryDiffEqVerner, OrdinaryDiffEqAMF
# The copied explicit/TaylorSeries.md documents `OrdinaryDiffEqTaylorSeries.*` bindings and
# globalerrorcontrol/GlobalDiffEq.md documents `GlobalRichardson`, so both packages have to
# be loaded here the way OrdinaryDiffEq's own docs/make.jl loads them.
import OrdinaryDiffEqTaylorSeries
using GlobalDiffEq
# The `@autodocs` blocks in the copied api/common_interface.md evaluate their
# `Modules = [...]` in this scope, so those modules have to be reachable from here too.
import ADTypes, SciMLOperators
using ImplicitDiscreteSolve, DiffEqDevTools
using StochasticDiffEqCore, StochasticDiffEqHighOrder, StochasticDiffEqIIF,
StochasticDiffEqImplicit, StochasticDiffEqLeaping, StochasticDiffEqLowOrder,
Expand Down Expand Up @@ -124,9 +132,11 @@ modules = [
OrdinaryDiffEqStabilizedIRK,
OrdinaryDiffEqStabilizedRK,
OrdinaryDiffEqSymplecticRK,
OrdinaryDiffEqTaylorSeries,
OrdinaryDiffEqTsit5,
OrdinaryDiffEqVerner,
OrdinaryDiffEqAMF,
GlobalDiffEq,
ImplicitDiscreteSolve,
DiffEqDevTools,
StochasticDiffEq,
Expand Down Expand Up @@ -192,9 +202,23 @@ makedocs(;
"https://github.com/JuliaSparse/KLU.jl",
"https://github.com/JuliaDiff/ForwardDiff.jl",
"https://www.mathworks.com/help/matlab/math/nonnegative-ode-solution.html",
# Absolute links baked into the upstream pages and docstrings copied into this site,
# pointing at pages that the deployed docs do not have: SciMLBase's Problem_Traits
# page is only in its unreleased docs, and OrdinaryDiffEq's devtools tree is
# deliberately dropped from this build above.
"https://docs.sciml.ai/SciMLBase/stable/interfaces/Problem_Traits/",
"https://docs.sciml.ai/OrdinaryDiffEq/stable/devtools/internals/public_api/",
# Paywalled reference from the ADTypes docstrings that api/common_interface.md pulls in.
"https://epubs.siam.org/doi/10.1137/S0036144504444711",
],
doctest = false, clean = true,
warnonly = [:missing_docs, :docs_block],
# The api/ordinarydiffeq and api/stochasticdiffeq trees are copied verbatim from the
# released packages, and the docstrings they render cross-reference solver internals
# (caches, `unwrap_alg`, the composite-algorithm switching types) that this aggregated
# site does not pull in as `@docs`. Those unresolvable `@ref`s are the same
# upstream-ownership problem that :docs_block and :missing_docs are already tolerated
# for here, so they must not fail the build either.
warnonly = [:missing_docs, :docs_block, :cross_references],
format = Documenter.HTML(
assets = ["assets/favicon.ico"],
canonical = "https://docs.sciml.ai/DiffEqDocs/stable/",
Expand Down
Loading