Merge pull request #551 from ChrisRackauckas-Claude/agent/public-doc-coverage

ChrisRackauckas · web-flow · commit e2b50b00feeb · 2026-07-12T10:05:52.000Z
Use SciMLTesting public API docs QA
diff --git a/Project.toml b/Project.toml
@@ -61,7 +61,7 @@ Reexport = "1.2"
 SafeTestsets = "0.1.0"
 SciMLBase = "3.30"
 SciMLLogging = "1.10.1, 2"
-SciMLTesting = "1"
+SciMLTesting = "2.1"
 Sparspak = "0.3.11"
 StaticArrays = "1.9.8"
 Test = "1.10"
diff --git a/docs/Project.toml b/docs/Project.toml
@@ -21,7 +21,6 @@ SciMLBase = "0bca4576-84f4-4d90-8ffe-ffa030f20462"
 SimpleBoundaryValueDiffEq = "be0294bd-f90f-4760-ac4e-3421ce2b2da0"
 
 [sources]
-BoundaryValueDiffEq = {path = ".."}
 BoundaryValueDiffEqAscher = {path = "../lib/BoundaryValueDiffEqAscher"}
 BoundaryValueDiffEqCore = {path = "../lib/BoundaryValueDiffEqCore"}
 BoundaryValueDiffEqFIRK = {path = "../lib/BoundaryValueDiffEqFIRK"}
diff --git a/docs/pages.jl b/docs/pages.jl
@@ -16,7 +16,7 @@ pages = [
         "solvers/mirk.md", "solvers/firk.md", "solvers/shooting.md", "solvers/mirkn.md",
         "solvers/ascher.md", "solvers/simple_solvers.md", "solvers/wrappers.md",
     ],
-    "Wrapped Solver APIs" => Any["api/odeinterface.md"],
+    "API" => Any["api/odeinterface.md"],
     "Development Documentation" => Any["devdocs/internal_interfaces.md"],
     "References" => "references.md",
 ]
diff --git a/docs/src/tutorials/extremum.md b/docs/src/tutorials/extremum.md
@@ -12,7 +12,7 @@ Let's walk through this functionality with an intuitive example. We still revisi
 where `lb=-4.8161991710010925` and `ub=5.0496477654230745`. So the states must conform that the maximum value of the state should be `lb` while the minimum value of the state should be `ub`. To solve such problems, we can simply use the `maxsol` and `minsol` functions when defining the boundary value problem in BoundaryValueDiffEq.jl.
 
 ```@example inequality
-using BoundaryValueDiffEq, Plots
+using BoundaryValueDiffEq
 tspan = (0.0, pi / 2)
 function simplependulum!(du, u, p, t)
     θ = u[1]
@@ -25,6 +25,16 @@ function bc!(residual, u, p, t)
     residual[2] = minsol(u, (0.0, pi / 2)) + 4.8161991710010925
 end
 prob = BVProblem(simplependulum!, bc!, [pi / 2, pi / 2], tspan)
-sol = solve(prob, MIRK4(), dt = 0.05)
+```
+
+For extremum boundary conditions, prefer a finite-difference Jacobian backend for
+the boundary condition residuals.
+
+```julia
+using Plots
+jac_alg = BVPJacobianAlgorithm(;
+    bc_diffmode = AutoFiniteDiff(), nonbc_diffmode = AutoSparse(AutoFiniteDiff())
+)
+sol = solve(prob, MIRK4(; jac_alg), dt = 0.05)
 plot(sol)
 ```
diff --git a/lib/BoundaryValueDiffEqAscher/Project.toml b/lib/BoundaryValueDiffEqAscher/Project.toml
@@ -31,7 +31,7 @@ Random = "1.10"
 RecursiveArrayTools = "3.27.0, 4"
 Reexport = "1.2"
 SciMLBase = "3.30"
-SciMLTesting = "1"
+SciMLTesting = "2.1"
 Setfield = "1.1.1"
 StaticArrays = "1.9.8"
 Test = "1.10"
diff --git a/lib/BoundaryValueDiffEqAscher/test/qa/Project.toml b/lib/BoundaryValueDiffEqAscher/test/qa/Project.toml
@@ -6,13 +6,12 @@ SciMLTesting = "09d9d899-5365-40a9-917a-5f67fddea283"
 Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
 
 [sources]
-BoundaryValueDiffEqAscher = {path = "../.."}
 BoundaryValueDiffEqCore = {path = "../../../BoundaryValueDiffEqCore"}
 
 [compat]
 Aqua = "0.8"
 BoundaryValueDiffEqAscher = "1"
 BoundaryValueDiffEqCore = "2"
-SciMLTesting = "1.6"
+SciMLTesting = "2.1"
 Test = "1.10"
 julia = "1.10"
diff --git a/lib/BoundaryValueDiffEqAscher/test/qa/qa.jl b/lib/BoundaryValueDiffEqAscher/test/qa/qa.jl
@@ -2,6 +2,27 @@ using SciMLTesting
 using BoundaryValueDiffEqAscher
 using Test
 
+const DOCS_SRC = normpath(joinpath(@__DIR__, "..", "..", "..", "..", "docs", "src"))
+
+function upstream_reexports_with_doc_ownership(pkg, owners, extra = ())
+    names = Set{Symbol}(extra)
+    for owner in owners
+        isdefined(pkg, owner) || continue
+        union!(names, SciMLTesting.public_api_names(getproperty(pkg, owner)))
+        push!(names, owner)
+    end
+    return Tuple(sort!(collect(names)))
+end
+
+const UPSTREAM_REEXPORTS_WITH_DOC_OWNERSHIP = upstream_reexports_with_doc_ownership(
+    BoundaryValueDiffEqAscher,
+    (:ADTypes, :NonlinearSolveFirstOrder, :SciMLBase, :SciMLOperators),
+    (
+        :AllObserved, :BoundaryValueDiffEqCore, :deleteat!, :init, :pickchunksize, :solve,
+        :solve!, :step!,
+    )
+)
+
 run_qa(
     BoundaryValueDiffEqAscher;
     explicit_imports = true,
@@ -13,4 +34,10 @@ run_qa(
         # no public replacement.
         all_qualified_accesses_are_public = (; ignore = (:Dual, :jacobian!)),
     ),
+    api_docs_kwargs = (;
+        rendered = true,
+        docs_src = DOCS_SRC,
+        ignore = UPSTREAM_REEXPORTS_WITH_DOC_OWNERSHIP,
+        rendered_ignore = UPSTREAM_REEXPORTS_WITH_DOC_OWNERSHIP,
+    ),
 )
diff --git a/lib/BoundaryValueDiffEqCore/Project.toml b/lib/BoundaryValueDiffEqCore/Project.toml
@@ -48,7 +48,7 @@ Reexport = "1.2"
 SciMLBase = "3.30"
 SciMLLogging = "1.10.1, 2"
 SciMLPublic = "1"
-SciMLTesting = "1"
+SciMLTesting = "2.1"
 SciMLStructures = "1.7.0"
 Setfield = "1"
 SparseArrays = "1.10"
diff --git a/lib/BoundaryValueDiffEqCore/test/qa/Project.toml b/lib/BoundaryValueDiffEqCore/test/qa/Project.toml
@@ -4,12 +4,9 @@ BoundaryValueDiffEqCore = "56b672f2-a5fe-4263-ab2d-da677488eb3a"
 SciMLTesting = "09d9d899-5365-40a9-917a-5f67fddea283"
 Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
 
-[sources]
-BoundaryValueDiffEqCore = {path = "../.."}
-
 [compat]
 Aqua = "0.8"
 BoundaryValueDiffEqCore = "2"
-SciMLTesting = "1.6"
+SciMLTesting = "2.1"
 Test = "1.10"
 julia = "1.10"
diff --git a/lib/BoundaryValueDiffEqCore/test/qa/qa.jl b/lib/BoundaryValueDiffEqCore/test/qa/qa.jl
@@ -2,6 +2,24 @@ using SciMLTesting
 using BoundaryValueDiffEqCore
 using Test
 
+const DOCS_SRC = normpath(joinpath(@__DIR__, "..", "..", "..", "..", "docs", "src"))
+
+function upstream_reexports_with_doc_ownership(pkg, owners, extra = ())
+    names = Set{Symbol}(extra)
+    for owner in owners
+        isdefined(pkg, owner) || continue
+        union!(names, SciMLTesting.public_api_names(getproperty(pkg, owner)))
+        push!(names, owner)
+    end
+    return Tuple(sort!(collect(names)))
+end
+
+const UPSTREAM_REEXPORTS_WITH_DOC_OWNERSHIP = upstream_reexports_with_doc_ownership(
+    BoundaryValueDiffEqCore,
+    (:NonlinearSolveFirstOrder, :SciMLBase, :SciMLOperators),
+    (:AllObserved, :deleteat!, :init, :pickchunksize, :solve, :solve!, :step!)
+)
+
 run_qa(
     BoundaryValueDiffEqCore;
     explicit_imports = true,
@@ -34,4 +52,10 @@ run_qa(
             ),
         ),
     ),
+    api_docs_kwargs = (;
+        rendered = true,
+        docs_src = DOCS_SRC,
+        ignore = UPSTREAM_REEXPORTS_WITH_DOC_OWNERSHIP,
+        rendered_ignore = UPSTREAM_REEXPORTS_WITH_DOC_OWNERSHIP,
+    ),
 )
diff --git a/lib/BoundaryValueDiffEqFIRK/Project.toml b/lib/BoundaryValueDiffEqFIRK/Project.toml
@@ -51,7 +51,7 @@ RecursiveArrayTools = "3.27.0, 4"
 Reexport = "1.2"
 SciMLBase = "3.30"
 SciMLStructures = "1.7.0"
-SciMLTesting = "1"
+SciMLTesting = "2.1"
 Setfield = "1.1.1"
 SparseArrays = "1.10"
 StaticArrays = "1.9.8"
diff --git a/lib/BoundaryValueDiffEqFIRK/test/AD/Project.toml b/lib/BoundaryValueDiffEqFIRK/test/AD/Project.toml
@@ -10,7 +10,6 @@ Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
 
 [sources]
 BoundaryValueDiffEqCore = {path = "../../../BoundaryValueDiffEqCore"}
-BoundaryValueDiffEqFIRK = {path = "../.."}
 
 [compat]
 BoundaryValueDiffEqCore = "2"
@@ -19,6 +18,6 @@ Enzyme = "0.13.33"
 ForwardDiff = "0.10.38, 1"
 Mooncake = "0.4.146, 0.5"
 SafeTestsets = "0.1.0"
-SciMLTesting = "1.7"
+SciMLTesting = "2.1"
 Test = "1.10"
 julia = "1.10"
diff --git a/lib/BoundaryValueDiffEqFIRK/test/qa/Project.toml b/lib/BoundaryValueDiffEqFIRK/test/qa/Project.toml
@@ -7,12 +7,11 @@ Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
 
 [sources]
 BoundaryValueDiffEqCore = {path = "../../../BoundaryValueDiffEqCore"}
-BoundaryValueDiffEqFIRK = {path = "../.."}
 
 [compat]
 Aqua = "0.8"
 BoundaryValueDiffEqCore = "2"
 BoundaryValueDiffEqFIRK = "1"
-SciMLTesting = "1.6"
+SciMLTesting = "2.1"
 Test = "1.10"
 julia = "1.10"
diff --git a/lib/BoundaryValueDiffEqFIRK/test/qa/qa.jl b/lib/BoundaryValueDiffEqFIRK/test/qa/qa.jl
@@ -2,6 +2,27 @@ using SciMLTesting
 using BoundaryValueDiffEqFIRK
 using Test
 
+const DOCS_SRC = normpath(joinpath(@__DIR__, "..", "..", "..", "..", "docs", "src"))
+
+function upstream_reexports_with_doc_ownership(pkg, owners, extra = ())
+    names = Set{Symbol}(extra)
+    for owner in owners
+        isdefined(pkg, owner) || continue
+        union!(names, SciMLTesting.public_api_names(getproperty(pkg, owner)))
+        push!(names, owner)
+    end
+    return Tuple(sort!(collect(names)))
+end
+
+const UPSTREAM_REEXPORTS_WITH_DOC_OWNERSHIP = upstream_reexports_with_doc_ownership(
+    BoundaryValueDiffEqFIRK,
+    (:ADTypes, :NonlinearSolveFirstOrder, :SciMLBase, :SciMLOperators),
+    (
+        :AllObserved, :BoundaryValueDiffEqCore, :deleteat!, :init, :pickchunksize, :solve,
+        :solve!, :step!,
+    )
+)
+
 run_qa(
     BoundaryValueDiffEqFIRK;
     explicit_imports = true,
@@ -18,4 +39,10 @@ run_qa(
             ignore = (:Tunable, :canonicalize, :isscimlstructure),
         ),
     ),
+    api_docs_kwargs = (;
+        rendered = true,
+        docs_src = DOCS_SRC,
+        ignore = UPSTREAM_REEXPORTS_WITH_DOC_OWNERSHIP,
+        rendered_ignore = UPSTREAM_REEXPORTS_WITH_DOC_OWNERSHIP,
+    ),
 )
diff --git a/lib/BoundaryValueDiffEqMIRK/Project.toml b/lib/BoundaryValueDiffEqMIRK/Project.toml
@@ -51,7 +51,7 @@ Reexport = "1.2"
 SafeTestsets = "0.1.0"
 SciMLBase = "3.30"
 SciMLStructures = "1.7.0"
-SciMLTesting = "1"
+SciMLTesting = "2.1"
 Setfield = "1.1.1"
 SparseArrays = "1.10"
 StaticArrays = "1.9.8"
diff --git a/lib/BoundaryValueDiffEqMIRK/test/AD/Project.toml b/lib/BoundaryValueDiffEqMIRK/test/AD/Project.toml
@@ -10,7 +10,6 @@ Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
 
 [sources]
 BoundaryValueDiffEqCore = {path = "../../../BoundaryValueDiffEqCore"}
-BoundaryValueDiffEqMIRK = {path = "../.."}
 
 [compat]
 BoundaryValueDiffEqCore = "2"
@@ -19,6 +18,6 @@ Enzyme = "0.13.33"
 ForwardDiff = "0.10.38, 1"
 Mooncake = "0.4, 0.5"
 SafeTestsets = "0.1.0"
-SciMLTesting = "1.7"
+SciMLTesting = "2.1"
 Test = "1.10"
 julia = "1.10"
diff --git a/lib/BoundaryValueDiffEqMIRK/test/qa/Project.toml b/lib/BoundaryValueDiffEqMIRK/test/qa/Project.toml
@@ -7,12 +7,11 @@ Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
 
 [sources]
 BoundaryValueDiffEqCore = {path = "../../../BoundaryValueDiffEqCore"}
-BoundaryValueDiffEqMIRK = {path = "../.."}
 
 [compat]
 Aqua = "0.8"
 BoundaryValueDiffEqCore = "2"
 BoundaryValueDiffEqMIRK = "1"
-SciMLTesting = "1.6"
+SciMLTesting = "2.1"
 Test = "1.10"
 julia = "1.10"
diff --git a/lib/BoundaryValueDiffEqMIRK/test/qa/qa.jl b/lib/BoundaryValueDiffEqMIRK/test/qa/qa.jl
@@ -2,6 +2,27 @@ using SciMLTesting
 using BoundaryValueDiffEqMIRK
 using Test
 
+const DOCS_SRC = normpath(joinpath(@__DIR__, "..", "..", "..", "..", "docs", "src"))
+
+function upstream_reexports_with_doc_ownership(pkg, owners, extra = ())
+    names = Set{Symbol}(extra)
+    for owner in owners
+        isdefined(pkg, owner) || continue
+        union!(names, SciMLTesting.public_api_names(getproperty(pkg, owner)))
+        push!(names, owner)
+    end
+    return Tuple(sort!(collect(names)))
+end
+
+const UPSTREAM_REEXPORTS_WITH_DOC_OWNERSHIP = upstream_reexports_with_doc_ownership(
+    BoundaryValueDiffEqMIRK,
+    (:ADTypes, :NonlinearSolveFirstOrder, :SciMLBase, :SciMLOperators),
+    (
+        :AllObserved, :BoundaryValueDiffEqCore, :deleteat!, :init, :pickchunksize, :solve,
+        :solve!, :step!,
+    )
+)
+
 run_qa(
     BoundaryValueDiffEqMIRK;
     explicit_imports = true,
@@ -18,4 +39,10 @@ run_qa(
             ignore = (:Tunable, :canonicalize, :isscimlstructure),
         ),
     ),
+    api_docs_kwargs = (;
+        rendered = true,
+        docs_src = DOCS_SRC,
+        ignore = UPSTREAM_REEXPORTS_WITH_DOC_OWNERSHIP,
+        rendered_ignore = UPSTREAM_REEXPORTS_WITH_DOC_OWNERSHIP,
+    ),
 )
diff --git a/lib/BoundaryValueDiffEqMIRKN/Project.toml b/lib/BoundaryValueDiffEqMIRKN/Project.toml
@@ -37,7 +37,7 @@ Random = "1.10"
 RecursiveArrayTools = "3.27.0, 4"
 Reexport = "1.2"
 SciMLBase = "3.30"
-SciMLTesting = "1"
+SciMLTesting = "2.1"
 Setfield = "1.1.1"
 StaticArrays = "1.9.8"
 Test = "1.10"
diff --git a/lib/BoundaryValueDiffEqMIRKN/test/qa/Project.toml b/lib/BoundaryValueDiffEqMIRKN/test/qa/Project.toml
@@ -7,12 +7,11 @@ Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
 
 [sources]
 BoundaryValueDiffEqCore = {path = "../../../BoundaryValueDiffEqCore"}
-BoundaryValueDiffEqMIRKN = {path = "../.."}
 
 [compat]
 Aqua = "0.8"
 BoundaryValueDiffEqCore = "2"
 BoundaryValueDiffEqMIRKN = "1"
-SciMLTesting = "1.6"
+SciMLTesting = "2.1"
 Test = "1.10"
 julia = "1.10"
diff --git a/lib/BoundaryValueDiffEqMIRKN/test/qa/qa.jl b/lib/BoundaryValueDiffEqMIRKN/test/qa/qa.jl
@@ -2,6 +2,27 @@ using SciMLTesting
 using BoundaryValueDiffEqMIRKN
 using Test
 
+const DOCS_SRC = normpath(joinpath(@__DIR__, "..", "..", "..", "..", "docs", "src"))
+
+function upstream_reexports_with_doc_ownership(pkg, owners, extra = ())
+    names = Set{Symbol}(extra)
+    for owner in owners
+        isdefined(pkg, owner) || continue
+        union!(names, SciMLTesting.public_api_names(getproperty(pkg, owner)))
+        push!(names, owner)
+    end
+    return Tuple(sort!(collect(names)))
+end
+
+const UPSTREAM_REEXPORTS_WITH_DOC_OWNERSHIP = upstream_reexports_with_doc_ownership(
+    BoundaryValueDiffEqMIRKN,
+    (:ADTypes, :NonlinearSolveFirstOrder, :SciMLBase, :SciMLOperators),
+    (
+        :AllObserved, :BoundaryValueDiffEqCore, :deleteat!, :init, :pickchunksize, :solve,
+        :solve!, :step!,
+    )
+)
+
 run_qa(
     BoundaryValueDiffEqMIRKN;
     explicit_imports = true,
@@ -13,4 +34,10 @@ run_qa(
             ignore = (:StandardSecondOrderBVProblem, :pickchunksize),
         ),
     ),
+    api_docs_kwargs = (;
+        rendered = true,
+        docs_src = DOCS_SRC,
+        ignore = UPSTREAM_REEXPORTS_WITH_DOC_OWNERSHIP,
+        rendered_ignore = UPSTREAM_REEXPORTS_WITH_DOC_OWNERSHIP,
+    ),
 )
diff --git a/lib/BoundaryValueDiffEqShooting/Project.toml b/lib/BoundaryValueDiffEqShooting/Project.toml
diff --git a/lib/BoundaryValueDiffEqShooting/test/qa/Project.toml b/lib/BoundaryValueDiffEqShooting/test/qa/Project.toml
diff --git a/lib/BoundaryValueDiffEqShooting/test/qa/qa.jl b/lib/BoundaryValueDiffEqShooting/test/qa/qa.jl
diff --git a/test/qa/Project.toml b/test/qa/Project.toml
diff --git a/test/qa/public_api_docs.jl b/test/qa/public_api_docs.jl
diff --git a/test/qa/qa.jl b/test/qa/qa.jl
diff --git a/test/runtests.jl b/test/runtests.jl
diff --git a/test/wrappers/Project.toml b/test/wrappers/Project.toml

Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,7 @@ pages = [`
`16`	`16`	`"solvers/mirk.md", "solvers/firk.md", "solvers/shooting.md", "solvers/mirkn.md",`
`17`	`17`	`"solvers/ascher.md", "solvers/simple_solvers.md", "solvers/wrappers.md",`
`18`	`18`	`],`
`19`		`- "Wrapped Solver APIs" => Any["api/odeinterface.md"],`
	`19`	`+ "API" => Any["api/odeinterface.md"],`
`20`	`20`	`"Development Documentation" => Any["devdocs/internal_interfaces.md"],`
`21`	`21`	`"References" => "references.md",`
`22`	`22`	`]`