docs: add NonlinearSolveHomotopyContinuation to docs

SciML · Jan 27, 2025 · a6f6e7b · a6f6e7b
1 parent c2aa812
commit a6f6e7b
Show file tree

Hide file tree

Showing 4 changed files with 22 additions and 2 deletions.
diff --git a/.github/workflows/Documentation.yml b/.github/workflows/Documentation.yml
@@ -22,7 +22,7 @@ jobs:
           Pkg.Registry.update()
           # Install packages present in subdirectories
           dev_pks = Pkg.PackageSpec[]
-          for path in ("lib/SciMLJacobianOperators", ".", "lib/SimpleNonlinearSolve", "lib/NonlinearSolveBase", "lib/BracketingNonlinearSolve", "lib/NonlinearSolveFirstOrder", "lib/NonlinearSolveQuasiNewton", "lib/NonlinearSolveSpectralMethods")
+          for path in ("lib/SciMLJacobianOperators", ".", "lib/SimpleNonlinearSolve", "lib/NonlinearSolveBase", "lib/BracketingNonlinearSolve", "lib/NonlinearSolveFirstOrder", "lib/NonlinearSolveQuasiNewton", "lib/NonlinearSolveSpectralMethods", "lib/NonlinearSolveHomotopyContinuation")
               push!(dev_pks, Pkg.PackageSpec(; path))
           end
           Pkg.develop(dev_pks)

diff --git a/docs/Project.toml b/docs/Project.toml
@@ -15,6 +15,7 @@ LinearSolve = "7ed4a6bd-45f5-4d41-b270-4a48e9bafcae"
 NonlinearSolve = "8913a72c-1f9b-4ce2-8d82-65094dcecaec"
 NonlinearSolveBase = "be0214bd-f91f-a760-ac4e-3421ce2b2da0"
 NonlinearSolveFirstOrder = "5959db7a-ea39-4486-b5fe-2dd0bf03d60d"
+NonlinearSolveHomotopyContinuation = "2ac3b008-d579-4536-8c91-a1a5998c2f8b"
 NonlinearSolveQuasiNewton = "9a2c21bd-3a47-402d-9113-8faf9a0ee114"
 NonlinearSolveSpectralMethods = "26075421-4e9a-44e1-8bd1-420ed7ad02b2"
 OrdinaryDiffEqTsit5 = "b1df2697-797e-41e3-8120-5422d3b24e4a"

diff --git a/docs/pages.jl b/docs/pages.jl
@@ -49,7 +49,8 @@ pages = [
         "api/petsc.md",
         "api/siamfanlequations.md",
         "api/speedmapping.md",
-        "api/sundials.md"
+        "api/sundials.md",
+        "api/homotopycontinuation.md"
     ],
     "Sub-Packages" => Any[
         "api/SciMLJacobianOperators.md",

diff --git a/docs/src/api/homotopycontinuation.md b/docs/src/api/homotopycontinuation.md
@@ -0,0 +1,18 @@
+# HomotopyContinuation.jl
+
+NonlinearSolve wraps the homotopy continuation algorithm implemented in
+HomotopyContinuation.jl. This solver is not included by default and needs
+to be installed separately:
+
+```julia
+using Pkg
+Pkg.add("NonlinearSolveHomotopyContinuation")
+using NonlinearSolveHomotopyContinuation, NonlinearSolve
+```
+
+# Solver API
+
+```@docs
+HomotopyContinuationJL
+SciMLBase.HomotopyContinuationFunction
+```