[Numpy-discussion] numpy docstring sphinx pre-processors
Mon Sep 21 12:20:29 CDT 2009
yes i saw this (http://svn.scipy.org/svn/numpy/trunk/doc/sphinxext/) but is
there a good description of how to use this? i'm looking for a "standard
recipe" that could be followed by myself and others. e.g. what functions to
call and in what order... i would like to emulate what numpy does as closely
On Mon, Sep 21, 2009 at 1:08 PM, Robert Kern <email@example.com> wrote:
> On Mon, Sep 21, 2009 at 12:03, Elaine Angelino
> <firstname.lastname@example.org> wrote:
> > Hi there --
> > I have been working on a small Python package whose central data object
> > comes from Numpy (the record array object).
> > I would like to produce documentation that looks like Numpy's, and am
> > planning to follow Numpy's docstring standard.
> > Numpy uses Sphinx to generate documentation (e.g. for HTML and LaTeX PDF
> > docs).
> > My understanding is that Numpy has its own pre-processors that modify the
> > docstrings to format them in reStructuredText (reST) before using Sphinx
> > produce the final output (see
> > Are these Numpy pre-processors available to the community? I would love
> > use them!
> Robert Kern
> "I have come to believe that the whole world is an enigma, a harmless
> enigma that is made terrible by our own mad attempt to interpret it as
> though it had an underlying truth."
> -- Umberto Eco
> NumPy-Discussion mailing list
-------------- next part --------------
An HTML attachment was scrubbed...
More information about the NumPy-Discussion