redid docs ToC and broke classes into seperate headings

f0uriest · Dec 28, 2018 · db03bef · db03bef
1 parent 4a2f651
commit db03bef
Show file tree

Hide file tree

Showing 11 changed files with 82 additions and 80 deletions.
diff --git a/docs/index.rst b/docs/index.rst
@@ -2,18 +2,34 @@
 
 
 .. toctree::
-   :caption: GASTOp Documentation
+   :caption: GASTOp Quickstart
    :maxdepth: 2
 
    installation
    usage
-   source/gastop
+
+.. toctree::
+   :caption: GASTOp Documentation
+   :maxdepth: 2
+
+   source/Crossover
+   source/Evaluator
+   source/Fitness
+   source/GenAlg
+   source/Mutator
+   source/Selector
+   source/Truss
+   source/encoders
+   source/utilities
+
+
+
+
 
 
 
 Indices and tables
 ==================
 
 * :ref:`genindex`
-* :ref:`modindex`
 * :ref:`search`
diff --git a/docs/source/Crossover.rst b/docs/source/Crossover.rst
@@ -0,0 +1,7 @@
+Crossover
+-----------------------
+
+.. autoclass:: gastop.crossover.Crossover
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/source/Evaluator.rst b/docs/source/Evaluator.rst
@@ -0,0 +1,7 @@
+Evaluator
+-----------------------
+
+.. autoclass:: gastop.evaluator.Evaluator
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/source/Fitness.rst b/docs/source/Fitness.rst
@@ -0,0 +1,7 @@
+FitnessFunction
+---------------------
+
+.. autoclass:: gastop.fitness.FitnessFunction
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/source/GenAlg.rst b/docs/source/GenAlg.rst
@@ -0,0 +1,7 @@
+GenAlg
+--------------------
+
+.. autoclass:: gastop.genalg.GenAlg
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/source/Mutator.rst b/docs/source/Mutator.rst
@@ -0,0 +1,7 @@
+Mutator
+---------------------
+
+.. autoclass:: gastop.mutator.Mutator
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/source/Selector.rst b/docs/source/Selector.rst
@@ -0,0 +1,7 @@
+Selector
+----------------------
+
+.. autoclass:: gastop.selector.Selector
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/source/Truss.rst b/docs/source/Truss.rst
@@ -0,0 +1,7 @@
+Truss
+-------------------
+
+.. autoclass:: gastop.truss.Truss
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/source/encoders.rst b/docs/source/encoders.rst
@@ -0,0 +1,7 @@
+encoders module
+----------------------
+
+.. automodule:: gastop.encoders
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/source/gastop.rst b/docs/source/gastop.rst
diff --git a/docs/source/utilities.rst b/docs/source/utilities.rst
@@ -0,0 +1,7 @@
+utilities module
+-----------------------
+
+.. automodule:: gastop.utilities
+    :members:
+    :undoc-members:
+    :show-inheritance: