NEW: sphinx+autodoc - proof of concept

Note that this only makes sense with the namespace_fixup branch of mdp.
mdp-toolkit · Jul 26, 2010 · ad42b8b · ad42b8b
1 parent 58c8bb8
commit ad42b8b
Show file tree

Hide file tree

Showing 11 changed files with 110 additions and 0 deletions.
diff --git a/sphinx/ext/private_members_too.py b/sphinx/ext/private_members_too.py
@@ -0,0 +1,12 @@
+import sys
+
+def do_not_skip(app, what, name, obj, skip, options):
+    ret = skip
+    if name.startswith('_') and not name.startswith('__'):
+        ret = False
+    #print "autodoc-skip-member", name, skip, '->', ret
+    return ret
+
+def setup(app):
+    app.connect('autodoc-skip-member', do_not_skip)
+    return
diff --git a/sphinx/source/doc/bimdp.rst b/sphinx/source/doc/bimdp.rst
@@ -0,0 +1,7 @@
+BiMDP module
+============
+
+.. automodule:: bimdp
+   :members:
+   :undoc-members:
+   :inherited-members:
diff --git a/sphinx/source/doc/index.rst b/sphinx/source/doc/index.rst
@@ -0,0 +1,9 @@
+.. _api:
+
+API documentation
+=================
+
+.. toctree::
+
+   mdp/index
+   bimdp
diff --git a/sphinx/source/doc/mdp/graph.rst b/sphinx/source/doc/mdp/graph.rst
@@ -0,0 +1,9 @@
+
+module mdp.graph
+================
+
+.. automodule:: mdp.graph
+   :members:
+   :undoc-members:
+   :inherited-members:
+   :show-inheritance:
diff --git a/sphinx/source/doc/mdp/helper_funcs.rst b/sphinx/source/doc/mdp/helper_funcs.rst
@@ -0,0 +1,9 @@
+=======================
+module mdp.helper_funcs
+=======================
+
+.. automodule:: mdp.helper_funcs
+   :members:
+   :undoc-members:
+   :inherited-members:
+   :show-inheritance:
diff --git a/sphinx/source/doc/mdp/hinet.rst b/sphinx/source/doc/mdp/hinet.rst
@@ -0,0 +1,9 @@
+
+module mdp.hinet
+================
+
+.. automodule:: mdp.hinet
+   :members:
+   :undoc-members:
+   :inherited-members:
+   :show-inheritance:
diff --git a/sphinx/source/doc/mdp/index.rst b/sphinx/source/doc/mdp/index.rst
@@ -0,0 +1,25 @@
+
+package mdp
+===========
+
+.. toctree::
+
+   nodes
+   graph
+   parallel
+   hinet
+   utils
+   helper_funcs
+
+.. automodule:: mdp
+   :members:
+   :undoc-members:
+   :inherited-members:
+   :show-inheritance:
+
+   Individual nodes are in :doc:`nodes`
+
+.. numx
+.. numx_fft
+.. numx_linalg
+.. numx_rand
diff --git a/sphinx/source/doc/mdp/nodes.rst b/sphinx/source/doc/mdp/nodes.rst
@@ -0,0 +1,11 @@
+================
+module mdp.nodes
+================
+
+.. contents::
+
+.. automodule:: mdp.nodes
+   :members:
+   :undoc-members:
+   :inherited-members:
+   :show-inheritance:
diff --git a/sphinx/source/doc/mdp/parallel.rst b/sphinx/source/doc/mdp/parallel.rst
@@ -0,0 +1,9 @@
+
+module mdp.parallel
+===================
+
+.. automodule:: mdp.parallel
+   :members:
+   :undoc-members:
+   :inherited-members:
+   :show-inheritance:
diff --git a/sphinx/source/doc/mdp/utils.rst b/sphinx/source/doc/mdp/utils.rst
@@ -0,0 +1,9 @@
+
+module mdp.utils
+================
+
+.. .. automodule:: mdp.utils
+..    :members:
+..    :undoc-members:
+..    :inherited-members:
+..    :show-inheritance:
diff --git a/sphinx/source/index.rst b/sphinx/source/index.rst
@@ -39,6 +39,7 @@ To learn more about MDP:
 * :ref:`Full list <node-list>` of implemented algorithms
 * Typical usage :ref:`examples <examples>`
 * `API Index <api/index.html>`_
+* `autodoc api <doc/index.html>`_
 
 Using MDP is as easy as: ::