fixed up autodoc stuff for new file structure

f0uriest · Dec 27, 2018 · 8c331f3 · 8c331f3
1 parent bdff7ad
commit 8c331f3
Show file tree

Hide file tree

Showing 25 changed files with 86 additions and 172 deletions.
diff --git a/.gitignore b/.gitignore
@@ -6,4 +6,5 @@ __pycache__/
 *#
 .coverage
 state_*.txt
-docs/_build
+docs/_build
+docs/_static
diff --git a/README.rst b/README.rst
@@ -17,9 +17,9 @@ Given a set of boundary conditions such as applied loads and fixtures, it will d
 
 Look how easy it is to use:
 ::
-    import gastop
-    # Get your stuff done
-    gastop.do_stuff()
+import gastop
+# Get your stuff done
+gastop.do_stuff()
 
 oh if only it were that easy
 
@@ -34,7 +34,7 @@ Installation
 
 Install gastop by running:
 ::
-    pip install gastop
+pip install gastop
 
 hopefully, if we ever get that working.
 Or, just clone the repo and throw together a random collection of virtualenvs and package interdepencies until it runs without errors.

diff --git a/docs/conf.py b/docs/conf.py
@@ -19,7 +19,7 @@
 
 # -- Project information -----------------------------------------------------
 
-project = 'gastop'
+project = 'GASTOp'
 copyright = '2018, Rory Conlin, Paul Kaneelil, Cristian Lacey, Susan Redmond, Dan Shaw, Amla Sinha'
 author = 'Rory Conlin, Paul Kaneelil, Cristian Lacey, Susan Redmond, Dan Shaw, Amla Sinha'
 
@@ -110,7 +110,6 @@
     'display_version': True,
     'prev_next_buttons_location': 'both',
     'style_external_links': False,
-    'vcs_pageview_mode': 'blob',
     # Toc options
     'collapse_navigation': True,
     'sticky_navigation': True,

diff --git a/docs/index.rst b/docs/index.rst
@@ -7,20 +7,8 @@
 
    installation
    usage
+   source/gastop
 
-.. toctree::
-   :caption: Classes and Functions
-   :maxdepth: 2
-
-   source/GenAlg
-   source/Crossover
-   source/Mutator
-   source/Selector
-   source/Truss
-   source/Eval
-   source/FitnessFunction
-   source/encoders
-   source/utilities
 
 
 Indices and tables

diff --git a/docs/source/Crossover.rst b/docs/source/Crossover.rst
diff --git a/docs/source/Eval.rst b/docs/source/Eval.rst
diff --git a/docs/source/FitnessFunction.rst b/docs/source/FitnessFunction.rst
diff --git a/docs/source/GASTOp.rst b/docs/source/GASTOp.rst
diff --git a/docs/source/GenAlg.rst b/docs/source/GenAlg.rst
diff --git a/docs/source/Mutator.rst b/docs/source/Mutator.rst
diff --git a/docs/source/Selector.rst b/docs/source/Selector.rst
diff --git a/docs/source/Truss.rst b/docs/source/Truss.rst
diff --git a/docs/source/encoders.rst b/docs/source/encoders.rst
diff --git a/docs/source/gastop.rst b/docs/source/gastop.rst
@@ -0,0 +1,77 @@
+GASTOp Package Contents
+==============
+
+Crossover
+-----------------------
+
+.. autoclass:: gastop.crossover.Crossover
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Evaluator
+-----------------------
+
+.. autoclass:: gastop.evaluator.Evaluator
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+FitnessFunction
+---------------------
+
+.. autoclass:: gastop.fitness.FitnessFunction
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+GenAlg
+--------------------
+
+.. autoclass:: gastop.genalg.GenAlg
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Mutator
+---------------------
+
+.. autoclass:: gastop.mutator.Mutator
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Selector
+----------------------
+
+.. autoclass:: gastop.selector.Selector
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Truss
+-------------------
+
+.. autoclass:: gastop.truss.Truss
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+encoders module
+----------------------
+
+.. automodule:: gastop.encoders
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+utilities module
+-----------------------
+
+.. automodule:: gastop.utilities
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+
diff --git a/docs/source/modules.rst b/docs/source/modules.rst
@@ -4,22 +4,4 @@ gastop
 .. toctree::
    :maxdepth: 4
 
-   Crossover
-   Eval
-   FitnessFunction
-   GASTOp
-   GenAlg
-   Mutator
-   Selector
-   Truss
-   encoders
-   susan_test
-   test_GenAlg
-   test_basic_optimization
-   test_crossover
-   test_eval
-   test_fitness
-   test_mutator
-   test_selector
-   test_utilities
-   utilities
+   gastop
diff --git a/docs/source/susan_test.rst b/docs/source/susan_test.rst
diff --git a/docs/source/test_GenAlg.rst b/docs/source/test_GenAlg.rst
diff --git a/docs/source/test_basic_optimization.rst b/docs/source/test_basic_optimization.rst
diff --git a/docs/source/test_crossover.rst b/docs/source/test_crossover.rst
diff --git a/docs/source/test_eval.rst b/docs/source/test_eval.rst
diff --git a/docs/source/test_fitness.rst b/docs/source/test_fitness.rst
diff --git a/docs/source/test_mutator.rst b/docs/source/test_mutator.rst
diff --git a/docs/source/test_selector.rst b/docs/source/test_selector.rst
diff --git a/docs/source/test_utilities.rst b/docs/source/test_utilities.rst
diff --git a/docs/source/utilities.rst b/docs/source/utilities.rst