docs: add SciMLJacobianOperators

Author: avik-pal

.github/workflows/Documentation.yml

@@ -23,7 +23,18 @@ jobs:
           JULIA_DEBUG: "Documenter"
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # For authentication with GitHub Actions token
           DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }} # For authentication with SSH deploy key
-        run: julia --project=docs/ --code-coverage=user --color=yes docs/make.jl
+        run: |
+          import Pkg
+          Pkg.Registry.update()
+          # Install packages present in subdirectories
+          dev_pks = Pkg.PackageSpec[]
+          for path in ("lib/SciMLJacobianOperators",)
+              push!(dev_pks, Pkg.PackageSpec(; path))
+          end
+          Pkg.develop(dev_pks)
+          Pkg.instantiate()
+          include("docs/make.jl")
+        shell: julia --project=docs/ --code-coverage=user --color=yes {0}
       - uses: julia-actions/julia-processcoverage@v1
       - uses: codecov/codecov-action@v4
         with:

docs/Project.toml

@@ -14,6 +14,7 @@ OrdinaryDiffEq = "1dea7af3-3e70-54e6-95c3-0bf5283fa5ed"
 Plots = "91a5bcdd-55d7-5caf-9e0b-520d859cae80"
 Random = "9a3f8284-a2c9-5f02-9a11-845980a1fd5c"
 SciMLBase = "0bca4576-84f4-4d90-8ffe-ffa030f20462"
+SciMLJacobianOperators = "19f34311-ddf3-4b8b-af20-060888a46c0e"
 SimpleNonlinearSolve = "727e6d20-b764-4bd8-a329-72de5adea6c7"
 SparseDiffTools = "47a9eef4-7e08-11e9-0b38-333d64bd3804"
 StaticArrays = "90137ffa-7385-5640-81b9-e52037218182"
@@ -36,6 +37,7 @@ OrdinaryDiffEq = "6"
 Plots = "1"
 Random = "<0.0.1, 1"
 SciMLBase = "2.4"
+SciMLJacobianOperators = "0.1"
 SimpleNonlinearSolve = "1"
 SparseDiffTools = "2.14"
 StaticArrays = "1"

docs/make.jl

@@ -1,6 +1,7 @@
 using Documenter, DocumenterCitations
 using NonlinearSolve, SimpleNonlinearSolve, Sundials, SteadyStateDiffEq, SciMLBase,
       DiffEqBase
+using SciMLJacobianOperators
 
 cp(joinpath(@__DIR__, "Manifest.toml"),
     joinpath(@__DIR__, "src/assets/Manifest.toml"), force = true)
@@ -13,8 +14,8 @@ bib = CitationBibliography(joinpath(@__DIR__, "src", "refs.bib"))
 
 makedocs(; sitename = "NonlinearSolve.jl",
     authors = "Chris Rackauckas",
-    modules = [NonlinearSolve, SimpleNonlinearSolve,
-        SteadyStateDiffEq, Sundials, DiffEqBase, SciMLBase],
+    modules = [NonlinearSolve, SimpleNonlinearSolve, SteadyStateDiffEq,
+        Sundials, DiffEqBase, SciMLBase, SciMLJacobianOperators],
     clean = true,
     doctest = false,
     linkcheck = true,

docs/src/api/SciMLJacobianOperators.md

@@ -0,0 +1,29 @@
+```@meta
+CurrentModule = SciMLJacobianOperators
+```
+
+# SciMLJacobianOperators.jl
+
+This is a subpackage on NonlinearSolve providing a general purpose JacVec and VecJac
+operator built on top on DifferentiationInterface.jl.
+
+```julia
+import Pkg
+Pkg.add("SciMLJacobianOperators")
+using SciMLJacobianOperators
+```
+
+## Jacobian API
+
+```@docs
+JacobianOperator
+VecJacOperator
+JacVecOperator
+```
+
+## Stateful Operators
+
+```@docs
+StatefulJacobianOperator
+StatefulJacobianNormalFormOperator
+```