[Numpy-discussion] Documentation

[Charles R Harris]

Hi All,

I've been trying out epydoc to see how things look. Apart from all the error
messages, it does run. However, I didn't like the appearance of the
documentation structured as suggested in numpy/doc, either in the terminal
or in the generated html. In particular, I didn't like the consolidated
lists and the interpreted variable names. I can see where these might be
useful down the road, but for now I stuck to definition lists with
italicized headings and plain old variable names.

Another problem we might want to address are the doctest blocks. Numpy
inserts blank lines when it is printing out multidimensional arrays and
because blank lines indicate the end of the block that screws up the
formatting. It would also be nice to make the SeeAlso entries links to
relevant functions.

Anyway, I've attached the html file generated from fromnumeric.py for your
flamage and suggestions. The routines I restructured are sort, argsort,
searchsorted, diagonal, std, var, and mean.

Chuck
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.python.org/pipermail/numpy-discussion/attachments/20070514/f09541cb/attachment.html>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: docs.zip
Type: application/zip
Size: 10287 bytes
Desc: not available
URL: <http://mail.python.org/pipermail/numpy-discussion/attachments/20070514/f09541cb/attachment.zip>