updated documentation

weiyang2048 · May 3, 2021 · 63a97a3 · 63a97a3
1 parent c73f2e4
commit 63a97a3
Show file tree

Hide file tree

Showing 4 changed files with 40 additions and 25 deletions.
diff --git a/docs/make.jl b/docs/make.jl
@@ -1,5 +1,13 @@
 using Documenter, RandomMatrix
 
+const PAGES = any["Home" =>"index.md",
+      "Random Matrix Models" =>[
+            "IID Matrices.md"=>"IID Matrices.md",
+            "Others" =>"Others.md"
+      ] 
+
+]
+
 makedocs(modules = [RandomMatrix],
       sitename="RandomMatrix.jl")
 

diff --git a/docs/src/IID Matrices.md b/docs/src/IID Matrices.md
@@ -0,0 +1,3 @@
+```@docs
+randMatrix
+```
diff --git a/docs/src/Others.md b/docs/src/Others.md
@@ -0,0 +1,27 @@
+```@docs
+randMatrix
+
+randHermitian
+
+randSymmetric
+
+randUnitary
+
+randOrthogonal
+
+Haar
+
+randPermutation
+
+randEllipic
+
+resolvent
+
+ComplexNormal
+
+Gaussian
+
+MarchenkoPastur
+
+±
+```
diff --git a/docs/src/index.md b/docs/src/index.md
@@ -1,29 +1,6 @@
 # RandomMatrix.jl Documentation
 
-```@docs
-randMatrix
+A package for Random Matrix Theory.
 
-randHermitian
+Hoping to add-in enough functionalities and register in Aug 2021. If there is any functionality you want me to implement, please raise an issue.
 
-randSymmetric
-
-randUnitary
-
-randOrthogonal
-
-Haar
-
-randPermutation
-
-randEllipic
-
-resolvent
-
-ComplexNormal
-
-Gaussian
-
-MarchenkoPastur
-
-±
-```