docs(docs): update references doc

TypedMatrices · Sep 8, 2024 · 3dc1633 · 3dc1633
1 parent a07f938
commit 3dc1633
Show file tree

Hide file tree

Showing 6 changed files with 71 additions and 26 deletions.
diff --git a/docs/make.jl b/docs/make.jl
@@ -17,7 +17,12 @@ makedocs(
             "manual/getting-started.md",
             "manual/performance.md",
         ],
-        "Reference" => "reference.md",
+        "References" => [
+            "references/1.types.md",
+            "references/2.interfaces.md",
+            "references/3.properties.md",
+            "references/4.builtin-matrices.md",
+        ],
     ],
 )
 

diff --git a/docs/src/manual/getting-started.md b/docs/src/manual/getting-started.md
@@ -36,7 +36,7 @@ Most matrices can accept a type parameter to specify the element type. For examp
 Hilbert{Float64}(5)
 ```
 
-Please check [Builtin Matrices](@ref) in [Reference](@ref) for all available builtin matrices.
+Please check [Builtin Matrices](@ref) for all available builtin matrices.
 
 ## Properties
 

diff --git a/docs/src/references/1.types.md b/docs/src/references/1.types.md
@@ -0,0 +1,7 @@
+# Types
+
+```@docs
+TypedMatrices.PropertyTypes
+TypedMatrices.Property
+TypedMatrices.Group
+```
diff --git a/docs/src/references/2.interfaces.md b/docs/src/references/2.interfaces.md
@@ -0,0 +1,12 @@
+# Interfaces
+
+```@docs
+TypedMatrices.list_properties
+TypedMatrices.@properties
+TypedMatrices.properties
+TypedMatrices.list_groups
+TypedMatrices.add_to_groups
+TypedMatrices.remove_from_group
+TypedMatrices.remove_from_all_groups
+TypedMatrices.list_matrices
+```
diff --git a/docs/src/references/3.properties.md b/docs/src/references/3.properties.md
@@ -0,0 +1,44 @@
+# Properties
+
+Some documentation of the following properties are adapted from MatrixDepot.jl.
+
+```@docs
+TypedMatrices.PropertyTypes.AbstractProperty
+TypedMatrices.PropertyTypes.Symmetric
+TypedMatrices.PropertyTypes.Inverse
+TypedMatrices.PropertyTypes.Involutory
+TypedMatrices.PropertyTypes.Integer
+TypedMatrices.PropertyTypes.IllCond
+TypedMatrices.PropertyTypes.PosDef
+TypedMatrices.PropertyTypes.Correlation
+TypedMatrices.PropertyTypes.Eigen
+TypedMatrices.PropertyTypes.Sparse
+TypedMatrices.PropertyTypes.Random
+TypedMatrices.PropertyTypes.RegProb
+TypedMatrices.PropertyTypes.Graph
+TypedMatrices.PropertyTypes.TotNonNeg
+TypedMatrices.PropertyTypes.TotPos
+TypedMatrices.PropertyTypes.InfDiv
+TypedMatrices.PropertyTypes.Indefinite
+TypedMatrices.PropertyTypes.Defective
+TypedMatrices.PropertyTypes.Nilpotent
+TypedMatrices.PropertyTypes.Hessenberg
+TypedMatrices.PropertyTypes.Toeplitz
+TypedMatrices.PropertyTypes.Binary
+TypedMatrices.PropertyTypes.RankDef
+TypedMatrices.PropertyTypes.Circulant
+TypedMatrices.PropertyTypes.Normal
+TypedMatrices.PropertyTypes.Orthogonal
+TypedMatrices.PropertyTypes.Bidiagonal
+TypedMatrices.PropertyTypes.Tridiagonal
+TypedMatrices.PropertyTypes.Triangular
+TypedMatrices.PropertyTypes.SingVal
+TypedMatrices.PropertyTypes.Rectangular
+TypedMatrices.PropertyTypes.Hankel
+TypedMatrices.PropertyTypes.DiagDom
+TypedMatrices.PropertyTypes.NonNeg
+TypedMatrices.PropertyTypes.Unimodular
+TypedMatrices.PropertyTypes.Positive
+TypedMatrices.PropertyTypes.FixedSize
+TypedMatrices.PropertyTypes.Complex
+```
diff --git a/docs/src/reference.md → docs/src/references/4.builtin-matrices.md b/docs/src/reference.md → docs/src/references/4.builtin-matrices.md
@@ -1,27 +1,4 @@
-# Reference
-
-## Types
-
-```@docs
-TypedMatrices.PropertyTypes
-TypedMatrices.Property
-TypedMatrices.Group
-```
-
-## Interfaces
-
-```@docs
-TypedMatrices.list_properties
-TypedMatrices.@properties
-TypedMatrices.properties
-TypedMatrices.list_groups
-TypedMatrices.add_to_groups
-TypedMatrices.remove_from_group
-TypedMatrices.remove_from_all_groups
-TypedMatrices.list_matrices
-```
-
-## Builtin Matrices
+# Builtin Matrices
 
 ```@docs
 TypedMatrices.Binomial