built the docs

vitruvianscience · Nov 4, 2015 · cf629df · cf629df
1 parent 0d7524d
commit cf629df
Show file tree

Hide file tree

Showing 9 changed files with 24 additions and 206 deletions.
diff --git a/build_docs.txt b/build_docs.txt
@@ -1,7 +1,8 @@
-Need to run sphinx-autodoc to create the docs from docstrings in code:
+Need to run sphinx-autodoc to create the docs from docstrings in code (terminal started in base opendeep folder):
 
-1) sphinx-apidoc -f -o docs/source/ opendeep/
-2) cd docs/
-3) make clean && make html
+1) rm docs/source/opendeep*.rst
+2) sphinx-apidoc -f -o docs/source/ opendeep/
+3) cd docs/
+4) make clean && make html
 
 Now you can view the html documentation in the build/ directory!
diff --git a/docs/source/opendeep.models.multi_layer.rst b/docs/source/opendeep.models.multi_layer.rst
diff --git a/docs/source/opendeep.models.multi_layer.tests.rst b/docs/source/opendeep.models.multi_layer.tests.rst
diff --git a/docs/source/opendeep.models.rst b/docs/source/opendeep.models.rst
@@ -7,7 +7,6 @@ Subpackages
 .. toctree::
 
     opendeep.models.container
-    opendeep.models.multi_layer
     opendeep.models.single_layer
     opendeep.models.tests
     opendeep.models.utils

diff --git a/docs/source/opendeep.models.single_layer.rst b/docs/source/opendeep.models.single_layer.rst
@@ -11,14 +11,6 @@ Subpackages
 Submodules
 ----------
 
-opendeep.models.single_layer.autoencoder module
------------------------------------------------
-
-.. automodule:: opendeep.models.single_layer.autoencoder
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
 opendeep.models.single_layer.basic module
 -----------------------------------------
 
@@ -51,10 +43,10 @@ opendeep.models.single_layer.lstm module
     :undoc-members:
     :show-inheritance:
 
-opendeep.models.single_layer.recurrent_hidden module
-----------------------------------------------------
+opendeep.models.single_layer.recurrent module
+---------------------------------------------
 
-.. automodule:: opendeep.models.single_layer.recurrent_hidden
+.. automodule:: opendeep.models.single_layer.recurrent
     :members:
     :undoc-members:
     :show-inheritance:

diff --git a/docs/source/opendeep.models.single_layer.tests.rst b/docs/source/opendeep.models.single_layer.tests.rst
@@ -28,6 +28,14 @@ opendeep.models.single_layer.tests.rbm_mnist module
     :undoc-members:
     :show-inheritance:
 
+opendeep.models.single_layer.tests.recurrent module
+---------------------------------------------------
+
+.. automodule:: opendeep.models.single_layer.tests.recurrent
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
 opendeep.models.single_layer.tests.softmax_mnist module
 -------------------------------------------------------
 

diff --git a/docs/source/opendeep.models.utils.rst b/docs/source/opendeep.models.utils.rst
@@ -20,6 +20,14 @@ opendeep.models.utils.modify_layer module
     :undoc-members:
     :show-inheritance:
 
+opendeep.models.utils.noise module
+----------------------------------
+
+.. automodule:: opendeep.models.utils.noise
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
 opendeep.models.utils.pooling module
 ------------------------------------
 

diff --git a/docs/source/opendeep.optimization.log_likelihood.rst b/docs/source/opendeep.optimization.log_likelihood.rst
diff --git a/docs/source/opendeep.optimization.log_likelihood.tests.rst b/docs/source/opendeep.optimization.log_likelihood.tests.rst