aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/conf.py3
-rw-r--r--doc/doc.txt23
-rw-r--r--doc/generate-libbe-txt.py52
-rw-r--r--doc/index.txt9
-rw-r--r--doc/libbe.bug.txt7
-rw-r--r--doc/libbe.bugdir.txt7
-rw-r--r--doc/libbe.comment.txt7
-rw-r--r--doc/libbe.txt14
8 files changed, 82 insertions, 40 deletions
diff --git a/doc/conf.py b/doc/conf.py
index ea03b08..1090a28 100644
--- a/doc/conf.py
+++ b/doc/conf.py
@@ -25,7 +25,8 @@ import libbe.version
# 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.doctest', 'sphinx.ext.coverage']
+extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.coverage',
+ 'numpydoc']
# Add any paths that contain templates here, relative to this directory.
templates_path = ['.templates']
diff --git a/doc/doc.txt b/doc/doc.txt
new file mode 100644
index 0000000..e1b7a3a
--- /dev/null
+++ b/doc/doc.txt
@@ -0,0 +1,23 @@
+****************************
+Producing this documentation
+****************************
+
+This documentation is written in reStructuredText_, and produced
+using Sphinx_ and the numpydoc_ extension. The documentation source
+should be fairly readable without processing, but you can compile the
+documentation, you'll need to install Sphinx and numpydoc::
+
+ $ easy_install Sphinx
+ $ easy_install numpydoc
+
+.. _Sphinx: http://sphinx.pocoo.org/
+.. _numpydoc: http://pypi.python.org/pypi/numpydoc
+
+See the reStructuredText quick reference and the `NumPy/SciPy
+documentation guide`_ for an introduction to the documentation
+syntax.
+
+.. _reStructuredText:
+ http://docutils.sourceforge.net/docs/user/rst/quickref.html
+.. _NumPy/SciPy documentation guide:
+ http://projects.scipy.org/numpy/wiki/CodingStyleGuidelines
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])
diff --git a/doc/index.txt b/doc/index.txt
index 9c964fa..6765a68 100644
--- a/doc/index.txt
+++ b/doc/index.txt
@@ -2,9 +2,9 @@ Welcome to the bugs-everywhere documentation!
=============================================
Bugs Everywhere (BE) is a bugtracker built on distributed version
-control. It works with Arch_ , Bazaar_ , Darcs_ , Git_ , and
-Mercurial_ at the moment, but is easily extensible. It can also
-function with no VCS at all.
+control. It works with Arch_, Bazaar_, Darcs_, Git_, and Mercurial_
+at the moment, but is easily extensible. It can also function with no
+VCS at all.
.. _Arch: http://www.gnu.org/software/gnu-arch/
.. _Bazaar: http://bazaar.canonical.com/
@@ -29,7 +29,8 @@ Contents:
distributed_bugtracking.txt
hacking.txt
spam.txt
- libbe.txt
+ libbe/libbe.txt
+ doc.txt
Indices and tables
==================
diff --git a/doc/libbe.bug.txt b/doc/libbe.bug.txt
deleted file mode 100644
index 41427c5..0000000
--- a/doc/libbe.bug.txt
+++ /dev/null
@@ -1,7 +0,0 @@
-****************
-:mod:`libbe.bug`
-****************
-
-.. automodule:: libbe.bug
- :members:
- :undoc-members:
diff --git a/doc/libbe.bugdir.txt b/doc/libbe.bugdir.txt
deleted file mode 100644
index 2464ea6..0000000
--- a/doc/libbe.bugdir.txt
+++ /dev/null
@@ -1,7 +0,0 @@
-*******************
-:mod:`libbe.bugdir`
-*******************
-
-.. automodule:: libbe.bugdir
- :members:
- :undoc-members:
diff --git a/doc/libbe.comment.txt b/doc/libbe.comment.txt
deleted file mode 100644
index 6e76f98..0000000
--- a/doc/libbe.comment.txt
+++ /dev/null
@@ -1,7 +0,0 @@
-********************
-:mod:`libbe.comment`
-********************
-
-.. automodule:: libbe.comment
- :members:
- :undoc-members:
diff --git a/doc/libbe.txt b/doc/libbe.txt
deleted file mode 100644
index 5d29434..0000000
--- a/doc/libbe.txt
+++ /dev/null
@@ -1,14 +0,0 @@
-************
-:mod:`libbe`
-************
-
-.. automodule:: libbe
- :members:
- :undoc-members:
-
-.. toctree::
- :maxdepth: 2
-
- libbe.bugdir.txt
- libbe.bug.txt
- libbe.comment.txt