[SciPy-user] Docstring standards for NumPy and SciPy
Alan G Isaac
aisaac at american.edu
Thu Jan 11 08:19:26 CST 2007
On Thu, 11 Jan 2007, Gary Ruben apparently wrote:
> currently no tools seem to do exactly what I think we want
> with ReST ... I think what is needed is to generate
> a simple reference section in the proposed LaTeX version
> of the document which contains one indexed entry per
> numpy/scipy function, probably with 'see also'
> cross-references, and also an html version of same. ...
> The other thing we want is to be able to generate examples
> from heavily marked-up example modules a'la what FiPy
> does. I don't think epydoc even allows that without
I would be great if someone who can be very specific about
such needs would ask Ed Loper if they are easily achieved.
It would be a shame to speculate incorrectly about that.
More information about the SciPy-user