fix documenter v1 demands

WIAS-PDELib · Jan 16, 2024 · 0cb41f2 · 0cb41f2
1 parent 02b739f
commit 0cb41f2
Show file tree

Hide file tree

Showing 9 changed files with 53 additions and 10 deletions.
diff --git a/docs/Project.toml b/docs/Project.toml
@@ -9,9 +9,8 @@ ILUZero = "88f59080-6952-5380-9ea5-54057fb9a43f"
 IncompleteLU = "40713840-3770-5561-ab4c-a76e7d0d7895"
 IterativeSolvers = "42fd0dbc-a981-5370-80f2-aaf504508153"
 LinearSolve = "7ed4a6bd-45f5-4d41-b270-4a48e9bafcae"
-Pardiso = "46dd5b70-b6fb-5a00-ae2d-e8fea33afaf2"
 Sparspak = "e56a9233-b9d6-4f03-8d0f-1825330902ac"
 
 [compat]
-IterativeSolvers = "0.9"
 Documenter = "1.0"
+IterativeSolvers = "0.9"
diff --git a/docs/make.jl b/docs/make.jl
@@ -1,11 +1,10 @@
 push!(LOAD_PATH, "../src/")
-using Documenter, ExtendableSparse, Pardiso, AlgebraicMultigrid, IncompleteLU, Sparspak
+using Documenter, ExtendableSparse, AlgebraicMultigrid, IncompleteLU, Sparspak, LinearAlgebra
 
 function mkdocs()
     makedocs(; sitename = "ExtendableSparse.jl",
              modules = [ExtendableSparse],
-             doctest = true,
-             warnonly = true, 
+             doctest = false,
              clean = false,
              authors = "J. Fuhrmann",
              repo = "https://github.com/j-fu/ExtendableSparse.jl",

diff --git a/docs/src/changes.md b/docs/src/changes.md
@@ -1,4 +1,11 @@
 # Changes
+## v1.3, Jan 16, 2024
+- AMGCLWrap extension, renamed AMGPreconditioner to RS_AMGPreconditioner
+- muted Pardiso
+
+## v1.2, August 5, 2023
+- Introduced 1.9 extensions for Pardiso, AlgebraicMultigrid, IncompleteLU
+
 ## v1.1, May 3, 2023
   - AbstractFactorization and subtypes are now without element and index type information.
     They wrap more concretely typed info. This shall allow to construct a preconditioner

diff --git a/docs/src/extsparse.md b/docs/src/extsparse.md
@@ -7,6 +7,12 @@ Modules = [ExtendableSparse]
 Pages = ["extendable.jl"]
 ```
 
+```@docs
+ExtendableSparse.lu
+LinearAlgebra.lu!
+LinearAlgebra.ldiv!
+```
+
 ## Test matrix creation
 
 ```@autodocs

diff --git a/docs/src/index.md b/docs/src/index.md
@@ -4,3 +4,8 @@ Markdown.parse("""
 $(read("../../README.md",String))
 """)
 ````
+
+
+## Index
+```@index
+```
diff --git a/docs/src/internal.md b/docs/src/internal.md
@@ -13,3 +13,9 @@ Pages = ["sparsematrixlnk.jl"]
 Modules = [ExtendableSparse]
 Pages = ["sparsematrixcsc.jl"]
 ```
+
+## Misc methods
+
+```@docs
+ExtendableSparse.@makefrommatrix :: Tuple{Any}
+```
diff --git a/docs/src/iter.md b/docs/src/iter.md
@@ -7,7 +7,10 @@ This functionality probably will be reduced in favor of LinearSolve.jl.
 In this package, preconditioners and LU factorizations are both seen
 as complete or approximate _factorizations_. Correspondingly we provide a common  API for them.
 
+```docs
 
+```
+ExtendableSparse.AbstractLUFactorization
 ```@autodocs
 Modules = [ExtendableSparse]
 Pages = ["factorizations.jl"]
@@ -28,11 +31,10 @@ The support comes in two flavors.
 
 ```@example
 using ExtendableSparse, LinearAlgebra
-using Pardiso
 A = fdrand(20, 20, 1; matrixtype = ExtendableSparseMatrix)
 n = size(A, 1)
 b = rand(n)
-factorization = MKLPardisoLU()
+factorization = SparspakLU()
 factorize!(factorization, A)
 nm1 = norm(factorization \ b)
 
@@ -72,6 +74,13 @@ Modules = [ExtendableSparse]
 Pages = ["umfpack_lu.jl",  "sparspak.jl"]
 ```
 
+```@docs
+ExtendableSparse.AbstractLUFactorization
+ExtendableSparse.CholeskyFactorization
+Base.:\
+```
+
+
 Pardiso extension:
 ```@docs
 PardisoLU
@@ -131,6 +140,10 @@ nm1, nm2
 
 #### Recommended 
 Available by default:
+
+```@docs
+ExtendableSparse.AbstractPreconditioner
+```
 ```@autodocs
 Modules = [ExtendableSparse]
 Pages = ["iluzero.jl","ilut.jl","amg.jl","blockpreconditioner.jl"]
@@ -139,7 +152,11 @@ Pages = ["iluzero.jl","ilut.jl","amg.jl","blockpreconditioner.jl"]
 Extensions:
 ```@docs
 ILUTPreconditioner
-AMGPreconditioner
+ExtendableSparse.AMGCL_AMGPreconditioner
+ExtendableSparse.AMGCL_RLXPreconditioner
+ExtendableSparse.RS_AMGPreconditioner
+ExtendableSparse.SA_AMGPreconditioner
+ExtendableSparse.AMGPreconditioner
 ```
 
 
@@ -149,3 +166,7 @@ Modules = [ExtendableSparse]
 Pages = ["jacobi.jl","parallel_jacobi.jl","ilu0.jl",]
 ```
 
+### Iteration schemes
+```@docs
+ExtendableSparse.simple!
+```
diff --git a/src/ExtendableSparse.jl b/src/ExtendableSparse.jl
@@ -89,7 +89,7 @@ AMGPreconditioner(matrix;max_levels=10, max_coarse=10)
 Create the  [`AMGPreconditioner`](@ref) wrapping the Ruge-Stüben AMG preconditioner from [AlgebraicMultigrid.jl](https://github.com/JuliaLinearAlgebra/AlgebraicMultigrid.jl)
 
 !!! warning
-   Deprecated in favor of [`RS_AMGPreconditioner`](@ref)
+     Deprecated in favor of [`RS_AMGPreconditioner`](@ref)
 
 """
 function AMGPreconditioner end 

diff --git a/src/factorizations/factorizations.jl b/src/factorizations/factorizations.jl
@@ -75,7 +75,7 @@ lu!(factorization, matrix)
 Update LU factorization, possibly reusing information from the current state.
 This method is aware of pattern changes.
 
-If `nothing` is passed as first parameter, [`factorize`](@ref) is called.
+If `nothing` is passed as first parameter, [`factorize!`](@ref) is called.
 """
 function LinearAlgebra.lu!(lufact::AbstractFactorization, A::ExtendableSparseMatrix)
     factorize!(lufact, A)