Keep sparse solvers docs as before (#552)

* Mark sparse linalg API as non-canonical * Add signatures * Include the sparse solvers API in a separate file for now since it conflicts with the one in julia stdlib.
JuliaSparse · Aug 11, 2024 · 55976a6 · 55976a6
1 parent 95fd7ff
commit 55976a6
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 26 deletions.
diff --git a/docs/make.jl b/docs/make.jl
@@ -8,6 +8,7 @@ makedocs(
     sitename = "SparseArrays",
     pages = Any[
         "SparseArrays" => "index.md",
+        "Sparse Linear Algebra API" => "solvers.md",
         ];
     warnonly = [:missing_docs, :cross_references],
     )

diff --git a/docs/src/index.md b/docs/src/index.md
@@ -210,19 +210,17 @@ section of the standard library reference.
 
 Sparse matrix solvers call functions from [SuiteSparse](http://suitesparse.com). The following factorizations are available:
 
+1. [`cholesky`](@ref SparseArrays.CHOLMOD.cholesky)
+2. [`ldlt`](@ref SparseArrays.CHOLMOD.ldlt)
+3. [`lu`](@ref SparseArrays.UMFPACK.lu)
+4. [`qr`](@ref SparseArrays.SPQR.qr)
+
 | Type                  | Description                                   |
 |:----------------------|:--------------------------------------------- |
 | `CHOLMOD.Factor`      | Cholesky and LDLt factorizations              |
 | `UMFPACK.UmfpackLU`   | LU factorization                              |
 | `SPQR.QRSparse`       | QR factorization                              |
 
-These factorizations are described in more detail in the [Sparse Linear Algebra API section](@ref stdlib-sparse-linalg-api):
-
-1. [`cholesky`](@ref SparseArrays.CHOLMOD.cholesky)
-2. [`ldlt`](@ref SparseArrays.CHOLMOD.ldlt)
-3. [`lu`](@ref SparseArrays.UMFPACK.lu)
-4. [`qr`](@ref SparseArrays.SPQR.qr)
-
 ```@meta
 DocTestSetup = nothing
 ```
@@ -267,25 +265,6 @@ SparseArrays.ftranspose!
 DocTestSetup = nothing
 ```
 
-# [Sparse Linear Algebra API](@id stdlib-sparse-linalg-api)
-
-```@docs
-SparseArrays.CHOLMOD.cholesky
-SparseArrays.CHOLMOD.cholesky!
-SparseArrays.CHOLMOD.lowrankupdate
-SparseArrays.CHOLMOD.lowrankupdate!
-SparseArrays.CHOLMOD.lowrankdowndate
-SparseArrays.CHOLMOD.lowrankdowndate!
-SparseArrays.CHOLMOD.lowrankupdowndate!
-SparseArrays.CHOLMOD.ldlt
-SparseArrays.UMFPACK.lu
-SparseArrays.SPQR.qr
-```
-
-```@meta
-DocTestSetup = nothing
-```
-
 # Noteworthy External Sparse Packages
 
 Several other Julia packages provide sparse matrix implementations that should be mentioned:

diff --git a/docs/src/solvers.md b/docs/src/solvers.md
@@ -0,0 +1,20 @@
+# Sparse Linear Algebra (API)
+
+```@meta
+DocTestSetup = :(using LinearAlgebra, SparseArrays)
+```
+
+```@docs; canonical=false
+SparseArrays.CHOLMOD.cholesky
+SparseArrays.CHOLMOD.cholesky!
+SparseArrays.CHOLMOD.lowrankdowndate
+SparseArrays.CHOLMOD.lowrankdowndate!
+SparseArrays.CHOLMOD.lowrankupdowndate!
+SparseArrays.CHOLMOD.ldlt
+SparseArrays.SPQR.qr
+SparseArrays.UMFPACK.lu
+```
+
+```@meta
+DocTestSetup = nothing
+```