[Nipy-devel] API docs

[Jarrod Millman]

Hey everyone,

You can view the epydoc-generated documentation for the codebase here:
 http://neuroimaging.scipy.org/api/

I used epydoc 2.1, which has a buglet that NiPy exposed.  There is a
patch file here:
http://projects.scipy.org/neuroimaging/ni/browser/ni/trunk/doc/epydoc-2.1.patch

I also tried using doxygen and epydoc-3.0alpha2.  I wasn't very
pleased with doxygen's handling
of Python, but epydoc 3.0 looks very promising.  Unfortunately, epydoc
3.0 wouldn't run on my system.  Once it gets closer to beta, I will
try again.  One nice new feature that it has is graph generation:
http://epydoc.sourceforge.net/api/epydoc.docwriter.dotgraph-module.html

Some of the nice features of epydoc 2.1 are:
1) Nicely colored-coded docstrings:
http://neuroimaging.scipy.org/api/attributes-module.html
2) Some math/symbol rendering (it isn't perfect, though):
http://neuroimaging.scipy.org/api/neuroimaging.reference-module.html
3) Cross referencing:
http://neuroimaging.scipy.org/api/neuroimaging.statistics.contrast.Contrast-class.html
4) External links:
http://neuroimaging.scipy.org/api/neuroimaging.tests-module.html

I am manually updating the docs for now, but eventually I will
investigate having them regenerated on a cron job every night.

Jarrod

PS. I will be out of email contact until Tuesday.