Skip to content

Commit a272109

Browse files
committed
Adapt to Documenter v1 (#444)
* Adapt to Documenter v1
1 parent baa418f commit a272109

File tree

4 files changed

+16
-10
lines changed

4 files changed

+16
-10
lines changed

docs/Project.toml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,5 @@
11
[deps]
22
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
3+
4+
[compat]
5+
Documenter = "1"

docs/make.jl

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,7 @@ makedocs(
1010
"SparseArrays" => "index.md",
1111
"Sparse Linear Algebra" => "solvers.md",
1212
];
13-
# strict = true,
14-
strict = Symbol[:doctest],
13+
warnonly = [:missing_docs, :cross_references],
1514
)
1615

1716
deploydocs(repo = "github.com/JuliaSparse/SparseArrays.jl.git")

docs/src/solvers.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,14 @@ Sparse matrix solvers call functions from [SuiteSparse](http://suitesparse.com).
1414

1515
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.
1616

17-
These factorizations are described in more detail in [`Linear Algebra`](https://docs.julialang.org/en/v1/stdlib/LinearAlgebra/) section of the manual:
18-
1. [`cholesky`](@ref)
19-
2. [`ldlt`](@ref)
20-
3. [`lu`](@ref)
21-
4. [`qr`](@ref)
17+
These factorizations are described in more detail in the
18+
[`Linear Algebra`](https://docs.julialang.org/en/v1/stdlib/LinearAlgebra/)
19+
section of the manual:
20+
21+
1. [`cholesky`](@ref SparseArrays.CHOLMOD.cholesky)
22+
2. [`ldlt`](@ref SparseArrays.CHOLMOD.ldlt)
23+
3. [`lu`](@ref SparseArrays.UMFPACK.lu)
24+
4. [`qr`](@ref SparseArrays.SPQR.qr)
2225

2326
```@docs
2427
SparseArrays.CHOLMOD.cholesky

src/solvers/cholmod.jl

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,8 @@ using LinearAlgebra
1818
using LinearAlgebra: RealHermSymComplexHerm, AdjOrTrans
1919
import LinearAlgebra: (\), AdjointFactorization,
2020
cholesky, cholesky!, det, diag, ishermitian, isposdef,
21-
issuccess, issymmetric, ldlt, ldlt!, logdet, lowrankdowndate!
21+
issuccess, issymmetric, ldlt, ldlt!, logdet,
22+
lowrankdowndate, lowrankdowndate!, lowrankupdate, lowrankupdate!
2223

2324
using SparseArrays
2425
using SparseArrays: getcolptr, AbstractSparseVecOrMat
@@ -1549,7 +1550,7 @@ factor will be `L*L' == P*A*P' + C'*C`
15491550
15501551
`update`: `Cint(1)` for `A + CC'`, `Cint(0)` for `A - CC'`
15511552
"""
1552-
lowrankdowndate!
1553+
lowrankupdowndate!
15531554

15541555
#Helper functions for rank updates
15551556
lowrank_reorder(V::AbstractArray,p) = Sparse(sparse(V[p,:]))
@@ -1598,7 +1599,7 @@ lowrankupdate(F::Factor{Tv}, V::AbstractArray{Tv}) where {Tv<:VTypes} =
15981599
lowrankupdate!(copy(F), V)
15991600

16001601
"""
1601-
lowrankupdate(F::CHOLMOD.Factor, C::AbstractArray) -> FF::CHOLMOD.Factor
1602+
lowrankdowndate(F::CHOLMOD.Factor, C::AbstractArray) -> FF::CHOLMOD.Factor
16021603
16031604
Get an `LDLt` Factorization of `A + C*C'` given an `LDLt` or `LLt` factorization `F` of `A`.
16041605

0 commit comments

Comments
 (0)