Merge pull request #55 from JesseLivezey/base-docs

JesseLivezey · web-flow · commit d41f291da837 · 2020-08-18T13:42:08.000-07:00
doc updates for base
diff --git a/docs/source/api.rst b/docs/source/api.rst
@@ -8,6 +8,7 @@ API
     :maxdepth: 2
 
     dca/dca
+    dca/base
     dca/methods_comparison
     dca/cov_util
     dca/synth_data
diff --git a/docs/source/dca/analysis.rst b/docs/source/dca/analysis.rst
@@ -1,6 +1,6 @@
-============
-dca.analysis
-============
+========
+Analysis
+========
 
 .. automodule:: dca.analysis
    :members:
diff --git a/docs/source/dca/base.rst b/docs/source/dca/base.rst
@@ -0,0 +1,6 @@
+================================
+Base Components Analysis Classes
+================================
+
+.. automodule:: dca.base
+   :members:
diff --git a/docs/source/dca/cov_util.rst b/docs/source/dca/cov_util.rst
@@ -1,6 +1,6 @@
-============
-dca.cov_util
-============
+====================
+Covariance Utilities
+====================
 
 .. automodule:: dca.cov_util
    :members:
diff --git a/docs/source/dca/data_util.rst b/docs/source/dca/data_util.rst
@@ -1,6 +1,6 @@
-=============
-dca.data_util
-=============
+==============
+Data Utilities
+==============
 
 .. automodule:: dca.data_util
    :members:
diff --git a/docs/source/dca/dca.rst b/docs/source/dca/dca.rst
@@ -1,6 +1,6 @@
-=======
-dca.dca
-=======
+=====================================
+Dynamical Components Analysis Classes
+=====================================
 
 .. automodule:: dca.dca
    :members:
diff --git a/docs/source/dca/methods_comparison.rst b/docs/source/dca/methods_comparison.rst
@@ -1,6 +1,6 @@
-======================
-dca.methods_comparison
-======================
+==================
+Methods Comparison
+==================
 
 .. automodule:: dca.methods_comparison
    :members:
diff --git a/docs/source/dca/synth_data.rst b/docs/source/dca/synth_data.rst
@@ -1,6 +1,6 @@
-==============
-dca.synth_data
-==============
+==================
+Synthetic Datasets
+==================
 
 .. automodule:: dca.synth_data
    :members:
