Test AutoAPI

docs/documentation.rst

@@ -1,9 +1,5 @@
-===================
-Documentation
-===================
-
 pydeep
-===================
+###############################
 
 .. automodule:: pydeep
    :members:
@@ -12,25 +8,181 @@ pydeep
    :inherited-members:
 
 base
-###############################
-.. toctree::
-   :maxdepth: 8
-   base<base.rst>
+********************************
+
+.. automodule:: pydeep.base
+   :members:
+   :private-members:
+   :special-members: __init__
+   :inherited-members:
+
+activationfunction
+================================
+
+.. automodule:: pydeep.base.activationfunction
+   :members:
+   :private-members:
+   :special-members: __init__
+   :inherited-members:
+
+basicstructure
+================================
+
+.. automodule:: pydeep.base.basicstructure
+   :members:
+   :private-members:
+   :special-members: __init__
+   :inherited-members:
+
+corruptor
+================================
+
+.. automodule:: pydeep.base.corruptor
+   :members:
+   :private-members:
+   :special-members: __init__
+   :inherited-members:
+
+costfunction
+================================
+
+.. automodule:: pydeep.base.costfunction
+   :members:
+   :private-members:
+   :special-members: __init__
+   :inherited-members:
+
+numpyextension
+================================
+
+.. automodule:: pydeep.base.numpyextension
+   :members:
+   :private-members:
+   :special-members: __init__
+   :inherited-members:
 
 misc
-###############################
-.. toctree::
-   :maxdepth: 8
-   misc<misc.rst>
+**********************************
 
-preprocessing
-###############################
-.. toctree::
-   :maxdepth: 8
-   preprocessing<preprocessing.rst>
+.. automodule:: pydeep.misc
+   :members:
+   :private-members:
+   :special-members: __init__
+   :inherited-members:
+
+io
+================================
+
+.. automodule:: pydeep.misc.io
+   :members:
+   :private-members:
+   :special-members: __init__
+   :inherited-members:
+
+measuring
+================================
+
+.. automodule:: pydeep.misc.measuring
+   :members:
+   :private-members:
+   :special-members: __init__
+   :inherited-members:
+
+sshthreadpool
+================================
+
+.. automodule:: pydeep.misc.sshthreadpool
+   :members:
+   :private-members:
+   :special-members: __init__
+   :inherited-members:
+
+toyproblems
+================================
+
+.. automodule:: pydeep.misc.toyproblems
+   :members:
+   :private-members:
+   :special-members: __init__
+   :inherited-members:
+
+visualization
+================================
+
+.. automodule:: pydeep.misc.visualization
+   :members:
+   :private-members:
+   :special-members: __init__
+   :inherited-members:
 
 rbm
-###############################
-.. toctree::
-   :maxdepth: 8
-   rbm<rbm.rst>
+**********************************
+
+.. automodule:: pydeep.rbm
+   :members:
+   :private-members:
+   :special-members: __init__
+   :inherited-members:
+
+model
+================================
+
+.. automodule:: pydeep.rbm.model
+   :members:
+   :private-members:
+   :special-members: __init__
+   :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:
+   :private-members:
+   :special-members: __init__
+   :inherited-members:
+
+estimator
+================================
+
+.. automodule:: pydeep.rbm.estimator
+   :members:
+   :private-members:
+   :special-members: __init__
+   :inherited-members:
+
+dbn
+================================
+
+.. automodule:: pydeep.rbm.dbn
+   :members:
+   :private-members:
+   :special-members: __init__
+   :inherited-members:
+
+preprocessing
+**********************************
+
+.. automodule:: pydeep.preprocessing
+   :members:
+   :private-members:
+   :special-members: __init__
+   :inherited-members:

docs/index.rst

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