[Docs] Reorganize the docs

Fixes #157
lrnv · Feb 19, 2024 · 06b6185 · 06b6185
1 parent 9fd6733
commit 06b6185
Show file tree

Hide file tree

Showing 8 changed files with 24 additions and 26 deletions.
diff --git a/docs/make.jl b/docs/make.jl
@@ -22,31 +22,29 @@ makedocs(;
         collapselevel=3,
     ),
     pages=[
-        "Copulas.jl package" => "index.md",
-        "Getting Started" => "getting_started.md",
-        "Sklar's Distributions" => "sklar.md",
-        "Elliptical Copulas" => [
-            "elliptical/generalities.md",
-            "elliptical/available_models.md",
+        "Home" => "index.md",
+        "Manual" => [
+            "Getting Started" => "getting_started.md",
+            "Sklar's Distributions" => "sklar.md",
+            "Elliptical Copulas" => "elliptical/generalities.md",
+            "Archimedean Copulas" => "archimedean/generalities.md",
+            "Liouville Copulas" => "Liouville.md",
+            "Empirical Copulas" => "empirical/generalities.md",
+            "Dependence measures" => "dependence_measures.md",
         ],
-        "Archimedean Copulas" => [
-            "archimedean/generalities.md",
+
+        "Bestiary" => [
+            "elliptical/available_models.md",
             "archimedean/available_models.md",
-        ],
-        "Liouville Copulas" => "Liouville.md",
-        "Other Copulas" => "miscellaneous.md",
-        "Transformed Copulas" => "transformations.md",
-        "Empirical Copulas" => [
-            "empirical/generalities.md",
             "empirical/available_models.md",
+            "Other Copulas" => "miscellaneous.md",
+            "Transformed Copulas" => "transformations.md",
         ],
-        "Dependence measures" => "dependence_measures.md",
         "Examples" => [
             "examples/fitting_sklar.md",
             "examples/turing.md",
             "examples/other_usecases.md"
         ],
-
         "Dev Roadmap" => "dev_roadmap.md",
         "Package Index" => "idx.md",
         "References" => "references.md",

diff --git a/docs/src/Liouville.md b/docs/src/Liouville.md
@@ -2,7 +2,7 @@
 CurrentModule = Copulas
 ```
 
-## Liouville Copulas
+# Liouville Copulas
 
 !!! note "Not merged yet !"
     Liouville copulas are coming in this PR : https://github.com/lrnv/Copulas.jl/pull/83, but this is not merged yet. 

diff --git a/docs/src/archimedean/available_models.md b/docs/src/archimedean/available_models.md
@@ -2,7 +2,7 @@
 CurrentModule = Copulas
 ```
 
-# [Available Models](@id available_archimedean_models)
+# [Archimedean Generators](@id available_archimedean_models)
 
 ## `WilliamsonGenerator`
 ```@docs; canonical=false

diff --git a/docs/src/elliptical/available_models.md b/docs/src/elliptical/available_models.md
@@ -2,7 +2,7 @@
 CurrentModule = Copulas
 ```
 
-# Available models
+# Elliptical Copulas
 
 ## `GaussianCopula`
 

diff --git a/docs/src/elliptical/generalities.md b/docs/src/elliptical/generalities.md
@@ -1,8 +1,8 @@
 ```@meta
 CurrentModule = Copulas
 ```
-# [General Discussion](@id elliptical_copulas_header)
-## Elliptical random vectors
+# [Elliptical Copulas](@id elliptical_copulas_header)
+
 
 The easiest families of copulas are the one derived from known families of random vectors, and the first presented one is, generally, the Elliptical family. 
 
@@ -24,7 +24,7 @@ This class contains the (multivariate) Normal and Student distributions, and it
 ```
 which is still a function of only the norm of $\bm t$. To fix ideas, for Gaussian random vectors, $\psi(t) = e^{-\frac{t^2}{2}}$.
 
-## Elliptical copulas
+
 
 Elliptical copulas are simply copulas of elliptical distributions. This simplicity of definition is paid for in the expression of the copulas itself: the obtained function has usually no better expression than: 
 ```math
@@ -44,7 +44,7 @@ On the other hand, there exist performant estimators of high-dimensional covaria
 !!! note "Discrepancy with the code"
     If the exposition we just did on characteristic functions of Elliptical random vectors is fundamental to the definition of elliptical copulas, the package does not use this at all to function, and rather rely on the existence of multivariate and corresponding univariate families of distributions in `Distributions.jl`. 
 
-## Implementation
+
 
 ```@docs
 EllipticalCopula

diff --git a/docs/src/empirical/available_models.md b/docs/src/empirical/available_models.md
@@ -2,7 +2,7 @@
 CurrentModule = Copulas
 ```
 
-# Available Models
+# Empirical Copulas
 
 ## `EmpiricalCopula`
 

diff --git a/docs/src/index.md b/docs/src/index.md
@@ -22,7 +22,7 @@ The package revolves around two main types:
 - `Copula`, the abstract mother type of all copulas
 - `SklarDist`, the type for multivariate compound distribution through [Sklar's theorem](https://en.wikipedia.org/wiki/Copula_(probability_theory)#Sklar's_theorem). 
 
-## Instalation
+## Installation
 
 The package is available on Julia's general registry, and can be installed as follows: 
 

diff --git a/docs/src/sklar.md b/docs/src/sklar.md
@@ -2,7 +2,7 @@
 CurrentModule = Copulas
 ```
 
-# Sklar's Theorem
+# Sklar's Distribution
 
 Recall the following theorem from [sklar1959](@cite):