diff options
| author | W. Trevor King <wking@drexel.edu> | 2010-02-06 16:53:57 -0500 |
|---|---|---|
| committer | W. Trevor King <wking@drexel.edu> | 2010-02-06 16:53:57 -0500 |
| commit | 413626d3b77e9bf89389a272ed489da29f3d9877 (patch) | |
| tree | 1595551db2db9f590f2bf36dfbae305a1e616c40 /README | |
| parent | 4c71190ebafd7ce198a5c0047588c4b2f7e5ef58 (diff) | |
| download | bugseverywhere-413626d3b77e9bf89389a272ed489da29f3d9877.tar.gz | |
Use numpydoc and generate-libbe-txt.py to autogenerate API documentation
Diffstat (limited to 'README')
| -rw-r--r-- | README | 11 |
1 files changed, 9 insertions, 2 deletions
@@ -57,8 +57,15 @@ If ``be help`` isn't scratching your itch, the full documentation is available in the doc directory as reStructuredText_ . You can build the full documentation with Sphinx_ , convert single files with docutils_ , or browse through the doc directory by hand. -doc/index.txt is a good place to start. +doc/index.txt is a good place to start. If you do use Sphinx, you'll +need to install numpydoc_ for automatically generating API +documentation. See the ``NumPy/SciPy documentation guide``_ for an +introduction to the syntax. -.. _reStructuredText: http://docutils.sourceforge.net/docs/user/rst/quickref.html +.. _reStructuredText: + http://docutils.sourceforge.net/docs/user/rst/quickref.html .. _Sphinx: http://sphinx.pocoo.org/ .. _docutils: http://docutils.sourceforge.net/ +.. _numpydoc: http://pypi.python.org/pypi/numpydoc +.. _NumPy/SciPy documentation guide: + http://projects.scipy.org/numpy/wiki/CodingStyleGuidelines |