Setup extended API pages

Author: ChrisRackauckas

docs/Project.toml

@@ -2,10 +2,20 @@
 BenchmarkTools = "6e4b80f9-dd63-53aa-95a3-0cdb28fa8baf"
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
 NonlinearSolve = "8913a72c-1f9b-4ce2-8d82-65094dcecaec"
+NonlinearSolveMINPACK = "c100e077-885d-495a-a2ea-599e143bf69d"
+SciMLNLSolve = "e9a6253c-8580-4d32-9898-8661bb511710"
+SimpleNonlinearSolve = "727e6d20-b764-4bd8-a329-72de5adea6c7"
 StaticArrays = "90137ffa-7385-5640-81b9-e52037218182"
+SteadyStateDiffEq = "9672c7b4-1e72-59bd-8a11-6ac3964bc41f"
+Sundials = "c3572dad-4567-51f8-b174-8c6c989267f4"
 
 [compat]
 BenchmarkTools = "1"
 Documenter = "0.27"
 NonlinearSolve = "1"
+NonlinearSolveMINPACK = "0.1"
+SciMLNLSolve = "0.1"
+SimpleNonlinearSolve = "0.1"
 StaticArrays = "1"
+SteadyStateDiffEq = "1.10"
+Sundials = "4.11"

docs/make.jl

@@ -1,4 +1,5 @@
-using Documenter, NonlinearSolve
+using Documenter, NonlinearSolve, SimpleNonlinearSolve, Sundials, SciMLNLSolve,
+      NonlinearSolveMINPACK, SteadyStateDiffEq
 
 cp("./docs/Manifest.toml", "./docs/src/assets/Manifest.toml", force = true)
 cp("./docs/Project.toml", "./docs/src/assets/Project.toml", force = true)
@@ -7,7 +8,8 @@ include("pages.jl")
 
 makedocs(sitename = "NonlinearSolve.jl",
          authors = "Chris Rackauckas",
-         modules = [NonlinearSolve, NonlinearSolve.SciMLBase],
+         modules = [NonlinearSolve, NonlinearSolve.SciMLBase, SimpleNonlinearSolve,
+         Sundials, SciMLNLSolve, NonlinearSolveMINPACK, SteadyStateDiffEq],
          clean = true, doctest = false,
          strict = [
              :doctest,

docs/pages.jl

@@ -7,7 +7,16 @@ pages = ["index.md",
                     "basics/NonlinearFunctions.md",
                     "basics/NonlinearSolution.md",
                     "basics/FAQ.md"],
-    "Solvers" => Any["solvers/NonlinearSystemSolvers.md",
+    "Solver Summaries and Recommendations" => Any[
+                     "solvers/NonlinearSystemSolvers.md",
                      "solvers/BracketingSolvers.md",
                      "solvers/SteadyStateSolvers.md"],
+    "Detailed Solver APIs" => Any[
+        "nonlinearsolve.md",
+        "simplenonlinearsolve.md",
+        "minpack.md",
+        "nlsolve.md",
+        "sundials.md",
+        "steadystatediffeq.md"
+    ]
 ]

docs/src/api/minpack.md

@@ -0,0 +1,18 @@
+# MINPACK.jl
+
+This is a wrapper package for importing solvers from Sundials into the SciML interface.
+Note that these solvers do not come by default, and thus one needs to install
+the package before using these solvers:
+
+```julia
+]add NonlinearSolveMINPACK
+using NonlinearSolveMINPACK
+```
+
+These methods can be used independently of the rest of NonlinearSolve.jl
+
+## Solver API
+
+```@docs
+CMINPACK
+```

docs/src/api/nlsolve.md

@@ -0,0 +1,16 @@
+# NLsolve.jl
+
+This is a wrapper package for importing solvers from NLsolve.jl into the SciML interface.
+Note that these solvers do not come by default, and thus one needs to install
+the package before using these solvers:
+
+```julia
+]add SciMLNLSolve
+using SciMLNLSolve
+```
+
+## Solver API
+
+```@docs
+NLsolveJL
+```

docs/src/api/nonlinearsolve.md

@@ -0,0 +1,9 @@
+# NonlinearSolve.jl Native Solvers
+
+These are the native solvers of NonlinearSolve.jl.
+
+## Solver API
+
+```@docs
+NewtonRaphson
+```

docs/src/api/simplenonlinearsolve.md

@@ -0,0 +1,11 @@
+# SimpleNonlinearSolve.jl
+
+These methods can be used independently of the rest of NonlinearSolve.jl
+
+## Solver API
+
+```@docs
+Bisection
+Falsi
+SimpleNewtonRaphson
+```

docs/src/api/steadystatediffeq.md

@@ -0,0 +1,19 @@
+# SteadyStateDiffEq.jl
+
+This is a wrapper package for using ODE solvers from
+[DifferentialEquations.jl](https://docs.sciml.ai/DiffEqDocs/stable/) into the SciML interface.
+Note that these solvers do not come by default, and thus one needs to install
+the package before using these solvers:
+
+```julia
+]add SteadyStateDiffEq
+using SteadyStateDiffEq
+```
+
+These methods can be used independently of the rest of NonlinearSolve.jl
+
+## Solver API
+
+```@docs
+DynamicSS
+```

docs/src/api/sundials.md

@@ -0,0 +1,18 @@
+## Sundials.jl
+
+This is a wrapper package for importing solvers from Sundials into the SciML interface.
+Note that these solvers do not come by default, and thus one needs to install
+the package before using these solvers:
+
+```julia
+]add Sundials
+using Sundials
+```
+
+These methods can be used independently of the rest of NonlinearSolve.jl
+
+## Solver API
+
+```@docs
+KINSOL
+```

docs/src/index.md

@@ -7,8 +7,8 @@ ability to use sparse automatic differentiation for Jacobian construction and
 Jacobian-vector products. It interfaces with other packages of the Julia ecosystem
 to make it easy to test alternative solver packages and pass small types to
 control algorithm swapping. It also interfaces with the
-[ModelingToolkit.jl](https://docs.sciml.ai/ModelingToolkit/stable/) world of symbolic modeling to
-allow for automatically generating high-performance code.
+[ModelingToolkit.jl](https://docs.sciml.ai/ModelingToolkit/stable/) world of symbolic
+modeling to allow for automatically generating high-performance code.
 
 Performance is key: the current methods are made to be highly performant on
 scalar and statically sized small problems, with options for large-scale systems.
@@ -39,14 +39,8 @@ Pkg.add("NonlinearSolve")
     - On the [Julia Discourse forums](https://discourse.julialang.org)
     - See also [SciML Community page](https://sciml.ai/community/)
 
-## Roadmap
-
-The current algorithms should support automatic differentiation, though improved
-adjoint overloads are planned to be added in the current update (which will make
-use of the `f(u,p)` form). Future updates will include standard methods for
-larger scale nonlinear solving like Newton-Krylov methods.
-
 ## Reproducibility
+
 ```@raw html
 <details><summary>The documentation of this SciML package was built using these direct dependencies,</summary>
 ```