aboutsummaryrefslogtreecommitdiffstats
path: root/doc/doc.txt
diff options
context:
space:
mode:
authorW. Trevor King <wking@drexel.edu>2010-02-06 16:53:57 -0500
committerW. Trevor King <wking@drexel.edu>2010-02-06 16:53:57 -0500
commit413626d3b77e9bf89389a272ed489da29f3d9877 (patch)
tree1595551db2db9f590f2bf36dfbae305a1e616c40 /doc/doc.txt
parent4c71190ebafd7ce198a5c0047588c4b2f7e5ef58 (diff)
downloadbugseverywhere-413626d3b77e9bf89389a272ed489da29f3d9877.tar.gz
Use numpydoc and generate-libbe-txt.py to autogenerate API documentation
Diffstat (limited to 'doc/doc.txt')
-rw-r--r--doc/doc.txt23
1 files changed, 23 insertions, 0 deletions
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