From febc53fa016cf414838ac41fe4c4cc313c00cc95 Mon Sep 17 00:00:00 2001
From: Art <wildart@users.noreply.github.com>
Date: Fri, 12 Mar 2021 23:59:15 -0500
Subject: [PATCH] add Documenter-based docs (index page) (#147)

---
 docs/Project.toml |  7 +++++++
 docs/make.jl      | 15 +++++++++++++++
 docs/src/index.md | 19 +++++++++++++++++++
 3 files changed, 41 insertions(+)
 create mode 100644 docs/Project.toml
 create mode 100644 docs/make.jl
 create mode 100644 docs/src/index.md

diff --git a/docs/Project.toml b/docs/Project.toml
new file mode 100644
index 0000000..853eb6f
--- /dev/null
+++ b/docs/Project.toml
@@ -0,0 +1,7 @@
+[deps]
+Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
+MultivariateStats = "6f286f6a-111f-5878-ab1e-185364afe411"
+StatsBase = "2913bbd2-ae8a-5f71-8c99-4fb6c76f3a91"
+
+[compat]
+Documenter = "0.26"
diff --git a/docs/make.jl b/docs/make.jl
new file mode 100644
index 0000000..ee5a7bb
--- /dev/null
+++ b/docs/make.jl
@@ -0,0 +1,15 @@
+using Documenter, MultivariateStats, StatsBase, Statistics, Random, LinearAlgebra
+
+if Base.HOME_PROJECT[] !== nothing
+    Base.HOME_PROJECT[] = abspath(Base.HOME_PROJECT[])
+end
+
+makedocs(
+    sitename = "MultivariateStats.jl",
+    modules = [MultivariateStats],
+    pages = ["index.md"]
+)
+
+deploydocs(
+    repo = "github.com/JuliaStats/MultivariateStats.jl.git"
+)
diff --git a/docs/src/index.md b/docs/src/index.md
new file mode 100644
index 0000000..f907015
--- /dev/null
+++ b/docs/src/index.md
@@ -0,0 +1,19 @@
+# MultivariateStats.jl Documentation
+
+```@meta
+CurrentModule = MultivariateStats
+DocTestSetup = quote
+    using Statistics
+    using Random
+end
+```
+
+[MultivariateStats.jl](https://github.com/JuliaStats/MultivariateStats.jl) is a Julia package for multivariate statistical analysis. It provides a rich set of useful analysis techniques, such as PCA, CCA, LDA, ICA, etc.
+
+
+```@contents
+Pages = []
+Depth = 2
+```
+
+**Notes:** All methods implemented in this package adopt the column-major convention of JuliaStats: in a data matrix, each column corresponds to a sample/observation, while each row corresponds to a feature (variable or attribute).