doc: move solvers doc to src\solvers.md (#576)

JuliaSparse · Oct 26, 2024 · 91b0aa5 · 91b0aa5
1 parent 5d3724a
commit 91b0aa5
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 8 deletions.
diff --git a/docs/src/index.md b/docs/src/index.md
@@ -202,6 +202,11 @@ section of the standard library reference.
 | [`sprandn(m,n,d)`](@ref)   | [`randn(m,n)`](@ref)   | Creates a *m*-by-*n* random matrix (of density *d*) with iid non-zero elements distributed according to the standard normal (Gaussian) distribution.                  |
 | [`sprandn(rng,m,n,d)`](@ref) | [`randn(rng,m,n)`](@ref) | Creates a *m*-by-*n* random matrix (of density *d*) with iid non-zero elements generated with the `rng` random number generator                                   |
 
+
+```@meta
+DocTestSetup = nothing
+```
+
 # [SparseArrays API](@id stdlib-sparse-arrays)
 
 ```@docs

diff --git a/docs/src/solvers.md b/docs/src/solvers.md
@@ -4,26 +4,33 @@
 DocTestSetup = :(using LinearAlgebra, SparseArrays)
 ```
 
-Sparse matrix solvers call functions from [SuiteSparse](http://suitesparse.com). The following factorizations are available:
+## [Sparse Linear Algebra](@id stdlib-sparse-linalg)
+
+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 factorization                        |
 | `UMFPACK.UmfpackLU`   | LU factorization                              |
 | `SPQR.QRSparse`       | QR factorization                              |
 
-Other solvers such as [Pardiso.jl](https://github.com/JuliaSparse/Pardiso.jl/) are available as external packages. [Arpack.jl](https://julialinearalgebra.github.io/Arpack.jl/stable/) provides `eigs` and `svds` for iterative solution of eigensystems and singular value decompositions.
+Other solvers such as [Pardiso.jl](https://github.com/JuliaSparse/Pardiso.jl/) are available
+as external packages. [Arpack.jl](https://julialinearalgebra.github.io/Arpack.jl/stable/)
+provides `eigs` and `svds` for iterative solution of eigensystems and singular value
+decompositions.
 
 These factorizations are described in more detail in the
 [`Linear Algebra`](https://docs.julialang.org/en/v1/stdlib/LinearAlgebra/)
 section of the manual:
 
-1. [`cholesky`](@ref SparseArrays.CHOLMOD.cholesky)
-2. [`ldlt`](@ref SparseArrays.CHOLMOD.ldlt)
-3. [`lu`](@ref SparseArrays.UMFPACK.lu)
-4. [`qr`](@ref SparseArrays.SPQR.qr)
-
-```@docs
+```@docs; canonical=false
 SparseArrays.CHOLMOD.cholesky
 SparseArrays.CHOLMOD.cholesky!
 SparseArrays.CHOLMOD.ldlt