Test AutoAPI

docs/conf.py

@@ -30,13 +30,13 @@
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = ['sphinx.ext.autodoc', 'sphinx.ext.intersphinx','autoapi.extension']
+extensions = ['sphinx.ext.autodoc', 'sphinx.ext.intersphinx']#,'autoapi.extension']
 
 # Document Python Code
-autoapi_type = 'python'
-autoapi_dirs = ['../pydeep']
-autoapi_file_pattern = '*.py'
-autoapi_options = ['members', 'private-members', 'special-members']
+#autoapi_type = 'python'
+#autoapi_dirs = ['../pydeep']
+#autoapi_file_pattern = '*.py'
+#autoapi_options = ['members', 'private-members', 'special-members']
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']

docs/documentation.rst

@@ -0,0 +1,179 @@
+pydeep
+###############################
+
+.. automodule:: pydeep
+   :members:
+   :private-members:
+   :special-members: __init__
+   :inherited-members:
+
+base
+********************************
+
+.. 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
+**********************************
+
+.. 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
+**********************************
+
+.. 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:
+
+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

@@ -37,6 +37,8 @@ Documentation
 .. toctree::
    :maxdepth: 2
 
+   Documentation<documentation.rst>
+
 ===================
 Indices and tables
 ===================