From 413626d3b77e9bf89389a272ed489da29f3d9877 Mon Sep 17 00:00:00 2001
From: "W. Trevor King" <wking@drexel.edu>
Date: Sat, 6 Feb 2010 16:53:57 -0500
Subject: Use numpydoc and generate-libbe-txt.py to autogenerate API
 documentation

---
 doc/generate-libbe-txt.py | 52 +++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 52 insertions(+)
 create mode 100644 doc/generate-libbe-txt.py

(limited to 'doc/generate-libbe-txt.py')

diff --git a/doc/generate-libbe-txt.py b/doc/generate-libbe-txt.py
new file mode 100644
index 0000000..ec874fa
--- /dev/null
+++ b/doc/generate-libbe-txt.py
@@ -0,0 +1,52 @@
+#!/usr/bin/python
+#
+# Copyright
+
+"""Auto-generate reStructuredText of the libbe module tree for Sphinx.
+"""
+
+import sys
+import os, os.path
+
+sys.path.insert(0, os.path.abspath('..'))
+from test import python_tree
+
+def title(modname):
+    t = ':mod:`%s`' % modname
+    delim = '*'*len(t)
+    return '\n'.join([delim, t, delim, '', ''])
+
+def automodule(modname):
+    return '\n'.join([
+            '.. automodule:: %s' % modname,
+            '   :members:',
+            '   :undoc-members:',
+            '', ''])
+
+def toctree(children):
+    if len(children) == 0:
+        return ''
+    return '\n'.join([
+            '.. toctree::',
+            '   :maxdepth: 2',
+            '',
+            ] + [
+            '   %s.txt' % c for c in children
+            ] + ['', ''])
+
+def make_module_txt(modname, children):
+    filename = os.path.join('libbe', '%s.txt' % modname)
+    if not os.path.exists('libbe'):
+        os.mkdir('libbe')
+    if os.path.exists(filename):
+        return None # don't overwrite potentially hand-written files.
+    f = file(filename, 'w')
+    f.write(title(modname))
+    f.write(automodule(modname))
+    f.write(toctree(children))
+    f.close()
+
+if __name__ == '__main__':
+    pt = python_tree(root_path='../libbe', root_modname='libbe')
+    for node in pt.traverse():
+        make_module_txt(node.modname, [c.modname for c in node])
-- 
cgit 


From 977eff5af10b50ba6e6edb6abc4f40804c418b12 Mon Sep 17 00:00:00 2001
From: "W. Trevor King" <wking@drexel.edu>
Date: Sun, 7 Feb 2010 17:53:53 -0500
Subject: Fixed docstrings so only Sphinx errors are "autosummary" and "missing
 attribute"

---
 doc/generate-libbe-txt.py | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'doc/generate-libbe-txt.py')

diff --git a/doc/generate-libbe-txt.py b/doc/generate-libbe-txt.py
index ec874fa..35eb5c4 100644
--- a/doc/generate-libbe-txt.py
+++ b/doc/generate-libbe-txt.py
@@ -31,7 +31,7 @@ def toctree(children):
             '   :maxdepth: 2',
             '',
             ] + [
-            '   %s.txt' % c for c in children
+            '   %s.txt' % c for c in sorted(children)
             ] + ['', ''])
 
 def make_module_txt(modname, children):
-- 
cgit