Docs working 🎉

Author: avik-pal

docs/Project.toml

@@ -8,6 +8,7 @@ IncompleteLU = "40713840-3770-5561-ab4c-a76e7d0d7895"
 LinearSolve = "7ed4a6bd-45f5-4d41-b270-4a48e9bafcae"
 ModelingToolkit = "961ee093-0014-501f-94e3-6117800e7a78"
 NonlinearSolve = "8913a72c-1f9b-4ce2-8d82-65094dcecaec"
+OrdinaryDiffEq = "1dea7af3-3e70-54e6-95c3-0bf5283fa5ed"
 Random = "9a3f8284-a2c9-5f02-9a11-845980a1fd5c"
 SciMLBase = "0bca4576-84f4-4d90-8ffe-ffa030f20462"
 SimpleNonlinearSolve = "727e6d20-b764-4bd8-a329-72de5adea6c7"
@@ -26,7 +27,6 @@ IncompleteLU = "0.2"
 LinearSolve = "2"
 ModelingToolkit = "8"
 NonlinearSolve = "3"
-NonlinearSolveMINPACK = "0.1"
 Random = "<0.0.1, 1"
 SciMLBase = "2.4"
 SimpleNonlinearSolve = "1"

docs/make.jl

@@ -1,13 +1,14 @@
 using Documenter,
-    NonlinearSolve, SimpleNonlinearSolve, Sundials,
-    SteadyStateDiffEq, SciMLBase, DiffEqBase
+    NonlinearSolve, SimpleNonlinearSolve, Sundials, SteadyStateDiffEq, SciMLBase, DiffEqBase
 
-cp("./docs/Manifest.toml", "./docs/src/assets/Manifest.toml", force = true)
-cp("./docs/Project.toml", "./docs/src/assets/Project.toml", force = true)
+cp(joinpath(@__DIR__, "Manifest.toml"), joinpath(@__DIR__, "src/assets/Manifest.toml"),
+    force = true)
+cp(joinpath(@__DIR__, "Project.toml"), joinpath(@__DIR__, "src/assets/Project.toml"),
+    force = true)
 
 include("pages.jl")
 
-makedocs(sitename = "NonlinearSolve.jl",
+makedocs(; sitename = "NonlinearSolve.jl",
     authors = "Chris Rackauckas",
     modules = [NonlinearSolve, SciMLBase, DiffEqBase, SimpleNonlinearSolve, Sundials,
         SteadyStateDiffEq],
@@ -16,7 +17,6 @@ makedocs(sitename = "NonlinearSolve.jl",
     warnonly = [:missing_docs, :cross_references],
     format = Documenter.HTML(assets = ["assets/favicon.ico"],
         canonical = "https://docs.sciml.ai/NonlinearSolve/stable/"),
-    pages = pages)
+    pages)
 
-deploydocs(repo = "github.com/SciML/NonlinearSolve.jl.git";
-    push_preview = true)
+deploydocs(repo = "github.com/SciML/NonlinearSolve.jl.git"; push_preview = true)

docs/src/release_notes.md

@@ -1,14 +1,14 @@
 # Release Notes
 
-## Breaking Changes in NonlinearSolve.jl v3
+## Breaking Changes in `NonlinearSolve.jl` v3
 
- 1. `GeneralBroyden` and `GeneralKlement` have been renamed to `Broyden` and `Klement`
+  - `GeneralBroyden` and `GeneralKlement` have been renamed to `Broyden` and `Klement`
     respectively.
- 2. Compat for `SimpleNonlinearSolve` has been bumped to `v1`.
- 3. The old style of specifying autodiff with `chunksize`, `standardtag`, etc. has been
+  - Compat for `SimpleNonlinearSolve` has been bumped to `v1`.
+  - The old style of specifying autodiff with `chunksize`, `standardtag`, etc. has been
     deprecated in favor of directly specifying the autodiff type, like `AutoForwardDiff`.
 
-## Breaking Changes in SimpleNonlinearSolve.jl v1
+## Breaking Changes in `SimpleNonlinearSolve.jl` v1
 
   - Batched solvers have been removed in favor of `BatchedArrays.jl`. Stay tuned for detailed
     tutorials on how to use `BatchedArrays.jl` with `NonlinearSolve` & `SimpleNonlinearSolve`

docs/src/tutorials/getting_started.md

@@ -201,6 +201,6 @@ see. Next check out:
   - [An iterator interface which lets you step through the solving process step by step](@ref iterator)
   - [How to handle large systems of equations efficiently](@ref large_systems)
   - [Ways to use NonlinearSolve.jl that is faster to startup and can statically compile](@ref fast_startup)
-  - [More detailed termination conditions](@ref termination_conditions_tutorial)
+  - [More detailed termination conditions](@ref termination_condition)
 
 And also check out the rest of the manual.

src/broyden.jl

@@ -14,7 +14,7 @@ An implementation of `Broyden` with resetting and line search.
   - `linesearch`: the line search algorithm to use. Defaults to [`LineSearch()`](@ref),
     which means that no line search is performed. Algorithms from `LineSearches.jl` can be
     used here directly, and they will be converted to the correct `LineSearch`. It is
-    recommended to use [LiFukushimaLineSearch](@ref) -- a derivative free linesearch
+    recommended to use [`LiFukushimaLineSearch`](@ref) -- a derivative free linesearch
     specifically designed for Broyden's method.
   - `alpha`: If `init_jacobian` is set to `Val(:identity)`, then the initial Jacobian
     inverse is set to be `(αI)⁻¹`. Defaults to `nothing` which implies

src/extension_algs.jl

@@ -159,7 +159,8 @@ end
     are line search types from
     [LineSearches.jl](https://github.com/JuliaNLSolvers/LineSearches.jl).
   - `linsolve`: a function `linsolve(x, A, b)` that solves `Ax = b`.
-  - `factor``: determines the size of the initial trust region. This size is set to the product of factor and the euclidean norm of `u0` if nonzero, or else to factor itself.
+  - `factor`: determines the size of the initial trust region. This size is set to the
+    product of factor and the euclidean norm of `u0` if nonzero, or else to factor itself.
   - `autoscale`: if true, then the variables will be automatically rescaled. The scaling
     factors are the norms of the Jacobian columns.
   - `m`: the amount of history in the Anderson method. Naive "Picard"-style iteration can be

src/lbroyden.jl

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