Test AutoAPI

docs/documentation.rst

@@ -1,14 +1,16 @@
+Documentation
+================
+
 pydeep
 ###############################
-
 .. automodule:: pydeep
    :members:
    :private-members:
    :special-members: __init__
    :inherited-members:
 
 base
-********************************
+-----------------
 
 .. automodule:: pydeep.base
    :members:
@@ -17,7 +19,7 @@ base
    :inherited-members:
 
 activationfunction
-================================
+~~~~~~~~~~~~~~~~~~~~~~
 
 .. automodule:: pydeep.base.activationfunction
    :members:
@@ -26,7 +28,7 @@ activationfunction
    :inherited-members:
 
 basicstructure
-================================
+~~~~~~~~~~~~~~~~~~~~~~
 
 .. automodule:: pydeep.base.basicstructure
    :members:
@@ -35,7 +37,7 @@ basicstructure
    :inherited-members:
 
 corruptor
-================================
+~~~~~~~~~~~~~~~~~~~~~~
 
 .. automodule:: pydeep.base.corruptor
    :members:
@@ -44,7 +46,7 @@ corruptor
    :inherited-members:
 
 costfunction
-================================
+~~~~~~~~~~~~~~~~~~~~~~
 
 .. automodule:: pydeep.base.costfunction
    :members:
@@ -53,7 +55,7 @@ costfunction
    :inherited-members:
 
 numpyextension
-================================
+~~~~~~~~~~~~~~~~~~~~~~
 
 .. automodule:: pydeep.base.numpyextension
    :members:
@@ -62,7 +64,7 @@ numpyextension
    :inherited-members:
 
 misc
-**********************************
+-----------------
 
 .. automodule:: pydeep.misc
    :members:
@@ -71,7 +73,7 @@ misc
    :inherited-members:
 
 io
-================================
+~~~~~~~~~~~~~~~~~~~~~~
 
 .. automodule:: pydeep.misc.io
    :members:
@@ -80,7 +82,7 @@ io
    :inherited-members:
 
 measuring
-================================
+~~~~~~~~~~~~~~~~~~~~~~
 
 .. automodule:: pydeep.misc.measuring
    :members:
@@ -89,7 +91,7 @@ measuring
    :inherited-members:
 
 sshthreadpool
-================================
+~~~~~~~~~~~~~~~~~~~~~~
 
 .. automodule:: pydeep.misc.sshthreadpool
    :members:
@@ -98,7 +100,7 @@ sshthreadpool
    :inherited-members:
 
 toyproblems
-================================
+~~~~~~~~~~~~~~~~~~~~~~
 
 .. automodule:: pydeep.misc.toyproblems
    :members:
@@ -107,7 +109,7 @@ toyproblems
    :inherited-members:
 
 visualization
-================================
+~~~~~~~~~~~~~~~~~~~~~~
 
 .. automodule:: pydeep.misc.visualization
    :members:
@@ -116,7 +118,7 @@ visualization
    :inherited-members:
 
 rbm
-**********************************
+-----------------
 
 .. automodule:: pydeep.rbm
    :members:
@@ -125,7 +127,7 @@ rbm
    :inherited-members:
 
 model
-================================
+~~~~~~~~~~~~~~~~~~~~~~
 
 .. automodule:: pydeep.rbm.model
    :members:
@@ -134,25 +136,16 @@ model
    :inherited-members:
 
 trainer
-================================
+~~~~~~~~~~~~~~~~~~~~~~
 
 .. automodule:: pydeep.rbm.trainer
    :members:
    :private-members:
    :special-members: __init__
    :inherited-members:
 
-CD
-#################################
-
-.. autoclass:: pydeep.rbm.trainer.CD
-   :members:
-   :private-members:
-   :special-members: __init__
-   :inherited-members:
-
 sampler
-================================
+~~~~~~~~~~~~~~~~~~~~~~
 
 .. automodule:: pydeep.rbm.sampler
    :members:
@@ -161,7 +154,7 @@ sampler
    :inherited-members:
 
 estimator
-================================
+~~~~~~~~~~~~~~~~~~~~~~
 
 .. automodule:: pydeep.rbm.estimator
    :members:
@@ -170,7 +163,7 @@ estimator
    :inherited-members:
 
 dbn
-================================
+~~~~~~~~~~~~~~~~~~~~~~
 
 .. automodule:: pydeep.rbm.dbn
    :members:
@@ -179,7 +172,7 @@ dbn
    :inherited-members:
 
 preprocessing
-**********************************
+-----------------
 
 .. automodule:: pydeep.preprocessing
    :members:

docs/index.rst

@@ -3,36 +3,37 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
+================================================
 Welcome to PyDeep's documentation!
-##################################
+================================================
 
 .. toctree::
    :maxdepth: 8
    :caption: Contents:
 
 Installation
-##################################
+================
 .. toctree::
    :maxdepth: 2
 
    Installation<installation.rst>
 
 Tutorials
-##################################
+================
 .. toctree::
    :maxdepth: 2
 
    Tutorials<tutorial.rst>
 
 Documentation
-##################################
+================
 .. toctree::
    :maxdepth: 8
 
    Documentation<documentation.rst>
 
 Indices and tables
-##################################
+================
 
 * :ref:`genindex`
 * :ref:`modindex`

docs/overview.rst

@@ -1,4 +1,4 @@
 Overview
-##################################
+================
 
 coming soon!

docs/tutorial.rst

@@ -1,4 +1,4 @@
 Tutorials
-##################################
+================
 
 coming soon!