Skip to content

Commit 0cb41f2

Browse files
committed
fix documenter v1 demands
1 parent 02b739f commit 0cb41f2

File tree

9 files changed

+53
-10
lines changed

9 files changed

+53
-10
lines changed

docs/Project.toml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,8 @@ ILUZero = "88f59080-6952-5380-9ea5-54057fb9a43f"
99
IncompleteLU = "40713840-3770-5561-ab4c-a76e7d0d7895"
1010
IterativeSolvers = "42fd0dbc-a981-5370-80f2-aaf504508153"
1111
LinearSolve = "7ed4a6bd-45f5-4d41-b270-4a48e9bafcae"
12-
Pardiso = "46dd5b70-b6fb-5a00-ae2d-e8fea33afaf2"
1312
Sparspak = "e56a9233-b9d6-4f03-8d0f-1825330902ac"
1413

1514
[compat]
16-
IterativeSolvers = "0.9"
1715
Documenter = "1.0"
16+
IterativeSolvers = "0.9"

docs/make.jl

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,10 @@
11
push!(LOAD_PATH, "../src/")
2-
using Documenter, ExtendableSparse, Pardiso, AlgebraicMultigrid, IncompleteLU, Sparspak
2+
using Documenter, ExtendableSparse, AlgebraicMultigrid, IncompleteLU, Sparspak, LinearAlgebra
33

44
function mkdocs()
55
makedocs(; sitename = "ExtendableSparse.jl",
66
modules = [ExtendableSparse],
7-
doctest = true,
8-
warnonly = true,
7+
doctest = false,
98
clean = false,
109
authors = "J. Fuhrmann",
1110
repo = "https://github.com/j-fu/ExtendableSparse.jl",

docs/src/changes.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,11 @@
11
# Changes
2+
## v1.3, Jan 16, 2024
3+
- AMGCLWrap extension, renamed AMGPreconditioner to RS_AMGPreconditioner
4+
- muted Pardiso
5+
6+
## v1.2, August 5, 2023
7+
- Introduced 1.9 extensions for Pardiso, AlgebraicMultigrid, IncompleteLU
8+
29
## v1.1, May 3, 2023
310
- AbstractFactorization and subtypes are now without element and index type information.
411
They wrap more concretely typed info. This shall allow to construct a preconditioner

docs/src/extsparse.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,12 @@ Modules = [ExtendableSparse]
77
Pages = ["extendable.jl"]
88
```
99

10+
```@docs
11+
ExtendableSparse.lu
12+
LinearAlgebra.lu!
13+
LinearAlgebra.ldiv!
14+
```
15+
1016
## Test matrix creation
1117

1218
```@autodocs

docs/src/index.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,3 +4,8 @@ Markdown.parse("""
44
$(read("../../README.md",String))
55
""")
66
````
7+
8+
9+
## Index
10+
```@index
11+
```

docs/src/internal.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,3 +13,9 @@ Pages = ["sparsematrixlnk.jl"]
1313
Modules = [ExtendableSparse]
1414
Pages = ["sparsematrixcsc.jl"]
1515
```
16+
17+
## Misc methods
18+
19+
```@docs
20+
ExtendableSparse.@makefrommatrix :: Tuple{Any}
21+
```

docs/src/iter.md

Lines changed: 24 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,10 @@ This functionality probably will be reduced in favor of LinearSolve.jl.
77
In this package, preconditioners and LU factorizations are both seen
88
as complete or approximate _factorizations_. Correspondingly we provide a common API for them.
99

10+
```docs
1011
12+
```
13+
ExtendableSparse.AbstractLUFactorization
1114
```@autodocs
1215
Modules = [ExtendableSparse]
1316
Pages = ["factorizations.jl"]
@@ -28,11 +31,10 @@ The support comes in two flavors.
2831

2932
```@example
3033
using ExtendableSparse, LinearAlgebra
31-
using Pardiso
3234
A = fdrand(20, 20, 1; matrixtype = ExtendableSparseMatrix)
3335
n = size(A, 1)
3436
b = rand(n)
35-
factorization = MKLPardisoLU()
37+
factorization = SparspakLU()
3638
factorize!(factorization, A)
3739
nm1 = norm(factorization \ b)
3840
@@ -72,6 +74,13 @@ Modules = [ExtendableSparse]
7274
Pages = ["umfpack_lu.jl", "sparspak.jl"]
7375
```
7476

77+
```@docs
78+
ExtendableSparse.AbstractLUFactorization
79+
ExtendableSparse.CholeskyFactorization
80+
Base.:\
81+
```
82+
83+
7584
Pardiso extension:
7685
```@docs
7786
PardisoLU
@@ -131,6 +140,10 @@ nm1, nm2
131140

132141
#### Recommended
133142
Available by default:
143+
144+
```@docs
145+
ExtendableSparse.AbstractPreconditioner
146+
```
134147
```@autodocs
135148
Modules = [ExtendableSparse]
136149
Pages = ["iluzero.jl","ilut.jl","amg.jl","blockpreconditioner.jl"]
@@ -139,7 +152,11 @@ Pages = ["iluzero.jl","ilut.jl","amg.jl","blockpreconditioner.jl"]
139152
Extensions:
140153
```@docs
141154
ILUTPreconditioner
142-
AMGPreconditioner
155+
ExtendableSparse.AMGCL_AMGPreconditioner
156+
ExtendableSparse.AMGCL_RLXPreconditioner
157+
ExtendableSparse.RS_AMGPreconditioner
158+
ExtendableSparse.SA_AMGPreconditioner
159+
ExtendableSparse.AMGPreconditioner
143160
```
144161

145162

@@ -149,3 +166,7 @@ Modules = [ExtendableSparse]
149166
Pages = ["jacobi.jl","parallel_jacobi.jl","ilu0.jl",]
150167
```
151168

169+
### Iteration schemes
170+
```@docs
171+
ExtendableSparse.simple!
172+
```

src/ExtendableSparse.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ AMGPreconditioner(matrix;max_levels=10, max_coarse=10)
8989
Create the [`AMGPreconditioner`](@ref) wrapping the Ruge-Stüben AMG preconditioner from [AlgebraicMultigrid.jl](https://github.com/JuliaLinearAlgebra/AlgebraicMultigrid.jl)
9090
9191
!!! warning
92-
Deprecated in favor of [`RS_AMGPreconditioner`](@ref)
92+
Deprecated in favor of [`RS_AMGPreconditioner`](@ref)
9393
9494
"""
9595
function AMGPreconditioner end

src/factorizations/factorizations.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ lu!(factorization, matrix)
7575
Update LU factorization, possibly reusing information from the current state.
7676
This method is aware of pattern changes.
7777
78-
If `nothing` is passed as first parameter, [`factorize`](@ref) is called.
78+
If `nothing` is passed as first parameter, [`factorize!`](@ref) is called.
7979
"""
8080
function LinearAlgebra.lu!(lufact::AbstractFactorization, A::ExtendableSparseMatrix)
8181
factorize!(lufact, A)

0 commit comments

Comments
 (0)