Test AutoAPI

docs/documentation.rst

@@ -1,14 +1,18 @@
-pydeep
-###############################
+===================
+Documentation
+===================
 
+
+PyDeep
+===================
 .. automodule:: pydeep
    :members:
    :private-members:
    :special-members: __init__
    :inherited-members:
 
 base
-********************************
+--------------------------
 
 .. automodule:: pydeep.base
    :members:
@@ -17,7 +21,7 @@ base
    :inherited-members:
 
 activationfunction
-================================
+``````````````````````````
 
 .. automodule:: pydeep.base.activationfunction
    :members:
@@ -26,7 +30,7 @@ activationfunction
    :inherited-members:
 
 basicstructure
-================================
+``````````````````````````
 
 .. automodule:: pydeep.base.basicstructure
    :members:
@@ -35,7 +39,7 @@ basicstructure
    :inherited-members:
 
 corruptor
-================================
+``````````````````````````
 
 .. automodule:: pydeep.base.corruptor
    :members:
@@ -44,7 +48,7 @@ corruptor
    :inherited-members:
 
 costfunction
-================================
+``````````````````````````
 
 .. automodule:: pydeep.base.costfunction
    :members:
@@ -53,7 +57,7 @@ costfunction
    :inherited-members:
 
 numpyextension
-================================
+``````````````````````````
 
 .. automodule:: pydeep.base.numpyextension
    :members:
@@ -62,7 +66,7 @@ numpyextension
    :inherited-members:
 
 misc
-**********************************
+--------------------------
 
 .. automodule:: pydeep.misc
    :members:
@@ -71,7 +75,7 @@ misc
    :inherited-members:
 
 io
-================================
+``````````````````````````
 
 .. automodule:: pydeep.misc.io
    :members:
@@ -80,7 +84,7 @@ io
    :inherited-members:
 
 measuring
-================================
+``````````````````````````
 
 .. automodule:: pydeep.misc.measuring
    :members:
@@ -89,7 +93,7 @@ measuring
    :inherited-members:
 
 sshthreadpool
-================================
+``````````````````````````
 
 .. automodule:: pydeep.misc.sshthreadpool
    :members:
@@ -98,7 +102,7 @@ sshthreadpool
    :inherited-members:
 
 toyproblems
-================================
+``````````````````````````
 
 .. automodule:: pydeep.misc.toyproblems
    :members:
@@ -107,7 +111,7 @@ toyproblems
    :inherited-members:
 
 visualization
-================================
+``````````````````````````
 
 .. automodule:: pydeep.misc.visualization
    :members:
@@ -116,7 +120,7 @@ visualization
    :inherited-members:
 
 rbm
-**********************************
+--------------------------
 
 .. automodule:: pydeep.rbm
    :members:
@@ -125,7 +129,7 @@ rbm
    :inherited-members:
 
 model
-================================
+``````````````````````````
 
 .. automodule:: pydeep.rbm.model
    :members:
@@ -134,7 +138,7 @@ model
    :inherited-members:
 
 trainer
-================================
+``````````````````````````
 
 .. automodule:: pydeep.rbm.trainer
    :members:
@@ -143,7 +147,7 @@ trainer
    :inherited-members:
 
 sampler
-================================
+``````````````````````````
 
 .. automodule:: pydeep.rbm.sampler
    :members:
@@ -152,7 +156,7 @@ sampler
    :inherited-members:
 
 estimator
-================================
+``````````````````````````
 
 .. automodule:: pydeep.rbm.estimator
    :members:
@@ -161,7 +165,7 @@ estimator
    :inherited-members:
 
 dbn
-================================
+``````````````````````````
 
 .. automodule:: pydeep.rbm.dbn
    :members:
@@ -170,10 +174,46 @@ dbn
    :inherited-members:
 
 preprocessing
-**********************************
+--------------------------
 
 .. automodule:: pydeep.preprocessing
    :members:
    :private-members:
    :special-members: __init__
    :inherited-members:
+
+STANDARIZER
+``````````````````````````
+
+.. autoclass:: pydeep.preprocessing.STANDARIZER
+   :members:
+   :private-members:
+   :special-members: __init__
+   :inherited-members:
+
+PCA
+``````````````````````````
+
+.. autoclass:: pydeep.preprocessing.PCA
+   :members:
+   :private-members:
+   :special-members: __init__
+   :inherited-members:
+
+ZCA
+``````````````````````````
+
+.. autoclass:: pydeep.preprocessing.PCA
+   :members:
+   :private-members:
+   :special-members: __init__
+   :inherited-members:
+
+ICA
+``````````````````````````
+
+.. autoclass:: pydeep.preprocessing.PCA
+   :members:
+   :private-members:
+   :special-members: __init__
+   :inherited-members:

docs/index.rst

@@ -8,34 +8,29 @@ Welcome to PyDeep
 ===================
 
 .. toctree::
-   :maxdepth: 2
    :caption: Contents:
 
 Installation
 ===================
 .. toctree::
-   :maxdepth: 2
 
    Installation<installation.rst>
 
 Overview
 ===================
 .. toctree::
-   :maxdepth: 2
 
    Features<overview.rst>
 
 Tutorials
 ===================
 .. toctree::
-   :maxdepth: 2
 
    Tutorials<tutorial.rst>
 
 Documentation
 ===================
 .. toctree::
-   :maxdepth: 2
 
    Documentation<documentation.rst>
 

docs/requirements.txt

@@ -3,5 +3,4 @@ scipy
 paramiko
 matplotlib
 encryptedpickle
-sphinx-autoapi