Skip to content

Commit b569244

Browse files
committed
Fix the docs to check for exports only
1 parent 1af69ba commit b569244

File tree

5 files changed

+11
-7
lines changed

5 files changed

+11
-7
lines changed

docs/make.jl

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,11 @@ include("pages.jl")
1010

1111
makedocs(; sitename = "NonlinearSolve.jl",
1212
authors = "Chris Rackauckas",
13-
modules = [NonlinearSolve, SimpleNonlinearSolve, SteadyStateDiffEq],
13+
modules = [NonlinearSolve, SimpleNonlinearSolve, SteadyStateDiffEq, Sundials,
14+
DiffEqBase, SciMLBase],
1415
clean = true, doctest = false, linkcheck = true,
1516
linkcheck_ignore = ["https://twitter.com/ChrisRackauckas/status/1544743542094020615"],
16-
warnonly = [:cross_references],
17+
warnonly = [:cross_references], checkdocs = :export,
1718
format = Documenter.HTML(assets = ["assets/favicon.ico"],
1819
canonical = "https://docs.sciml.ai/NonlinearSolve/stable/"),
1920
pages)

docs/src/api/nonlinearsolve.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ PseudoTransient
1010
DFSane
1111
Broyden
1212
Klement
13+
LimitedMemoryBroyden
1314
```
1415

1516
## Nonlinear Least Squares Solvers
@@ -50,4 +51,6 @@ RadiusUpdateSchemes.Hei
5051
RadiusUpdateSchemes.Yuan
5152
RadiusUpdateSchemes.Bastin
5253
RadiusUpdateSchemes.Fan
54+
RadiusUpdateSchemes.NLsolve
55+
RadiusUpdateSchemes.NocedalWright
5356
```

docs/src/api/simplenonlinearsolve.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ i.e. `IntervalNonlinearProblem`.
1111

1212
```@docs
1313
ITP
14+
Alefeld
1415
Bisection
1516
Falsi
1617
Ridder

docs/src/tutorials/large_systems.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -136,11 +136,10 @@ using BenchmarkTools # for @btime
136136
@btime solve(prob_brusselator_2d, NewtonRaphson());
137137
@btime solve(prob_brusselator_2d, NewtonRaphson(; autodiff = AutoSparseForwardDiff()));
138138
@btime solve(prob_brusselator_2d,
139-
NewtonRaphson(; autodiff = AutoSparseForwardDiff(),
140-
linsolve = KLUFactorization()));
139+
NewtonRaphson(; autodiff = AutoSparseForwardDiff(), linsolve = KLUFactorization()));
141140
@btime solve(prob_brusselator_2d,
142-
NewtonRaphson(; autodiff = AutoSparseForwardDiff(),
143-
linsolve = KrylovJL_GMRES()));
141+
NewtonRaphson(; autodiff = AutoSparseForwardDiff(), linsolve = KrylovJL_GMRES()));
142+
nothing # hide
144143
```
145144

146145
## Declaring a Sparse Jacobian with Automatic Sparsity Detection

src/lbroyden.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ An implementation of `LimitedMemoryBroyden` with resetting and line search.
1414
- `linesearch`: the line search algorithm to use. Defaults to [`LineSearch()`](@ref),
1515
which means that no line search is performed. Algorithms from `LineSearches.jl` can be
1616
used here directly, and they will be converted to the correct `LineSearch`. It is
17-
recommended to use [`LiFukushimaLineSearchCache`](@ref) -- a derivative free linesearch
17+
recommended to use [`LiFukushimaLineSearch`](@ref) -- a derivative free linesearch
1818
specifically designed for Broyden's method.
1919
"""
2020
@concrete struct LimitedMemoryBroyden{threshold} <: AbstractNewtonAlgorithm{false, Nothing}

0 commit comments

Comments
 (0)