Skip to content

Commit 814604b

Browse files
committed
docs: fix references
1 parent 031729b commit 814604b

File tree

4 files changed

+10
-11
lines changed

4 files changed

+10
-11
lines changed

docs/make.jl

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,11 @@ bib = CitationBibliography(joinpath(@__DIR__, "src", "refs.bib"))
1414

1515
interlinks = InterLinks(
1616
"ADTypes" => "https://sciml.github.io/ADTypes.jl/stable/",
17+
"LineSearch" => "https://sciml.github.io/LineSearch.jl/dev/"
1718
)
1819

19-
makedocs(; sitename = "NonlinearSolve.jl",
20+
makedocs(;
21+
sitename = "NonlinearSolve.jl",
2022
authors = "Chris Rackauckas",
2123
modules = [NonlinearSolve, SimpleNonlinearSolve, SteadyStateDiffEq,
2224
Sundials, DiffEqBase, SciMLBase, SciMLJacobianOperators],
@@ -30,6 +32,7 @@ makedocs(; sitename = "NonlinearSolve.jl",
3032
plugins = [bib, interlinks],
3133
format = Documenter.HTML(assets = ["assets/favicon.ico", "assets/citations.css"],
3234
canonical = "https://docs.sciml.ai/NonlinearSolve/stable/"),
33-
pages)
35+
pages
36+
)
3437

3538
deploydocs(repo = "github.com/SciML/NonlinearSolve.jl.git"; push_preview = true)

docs/src/native/globalization.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,9 @@ Pages = ["globalization.md"]
88

99
## [Line Search Algorithms](@id line-search)
1010

11-
```@docs
12-
LiFukushimaLineSearch
13-
LineSearchesJL
14-
RobustNonMonotoneLineSearch
15-
NoLineSearch
16-
```
11+
Line Searches have been moved to an external package. Take a look at the
12+
[LineSearch.jl](https://github.com/SciML/LineSearch.jl) package and its
13+
[documentation](https://sciml.github.io/LineSearch.jl/dev/).
1714

1815
## Radius Update Schemes for Trust Region
1916

docs/src/native/solvers.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ documentation.
2222
preconditioners. For more information on specifying preconditioners for LinearSolve
2323
algorithms, consult the
2424
[LinearSolve.jl documentation](https://docs.sciml.ai/LinearSolve/stable/).
25-
- `linesearch`: the line search algorithm to use. Defaults to [`NoLineSearch()`](@ref),
25+
- `linesearch`: the line search algorithm to use. Defaults to [`NoLineSearch()`](@extref LineSearch.NoLineSearch),
2626
which means that no line search is performed. Algorithms from
2727
[`LineSearches.jl`](https://github.com/JuliaNLSolvers/LineSearches.jl/) must be
2828
wrapped in [`LineSearchesJL`](@ref) before being supplied. For a detailed documentation

src/internal/jacobian.jl

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,7 @@ Construct a cache for the Jacobian of `f` w.r.t. `u`.
2525
- `jvp_autodiff`: Automatic Differentiation or Finite Differencing backend for computing
2626
the Jacobian-vector product.
2727
- `linsolve`: Linear Solver Algorithm used to determine if we need a concrete jacobian
28-
or if possible we can just use a [`SciMLJacobianOperators.JacobianOperator`](@ref)
29-
instead.
28+
or if possible we can just use a `SciMLJacobianOperators.JacobianOperator` instead.
3029
"""
3130
@concrete mutable struct JacobianCache{iip} <: AbstractNonlinearSolveJacobianCache{iip}
3231
J

0 commit comments

Comments
 (0)