[Numpy-discussion] numpy docstring sphinx pre-processors

Elaine Angelino elaine.angelino@gmail....
Mon Sep 21 12:20:29 CDT 2009


thanks robert!

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
as possible.

thanks again,

elaine


On Mon, Sep 21, 2009 at 1:08 PM, Robert Kern <robert.kern@gmail.com> wrote:

> On Mon, Sep 21, 2009 at 12:03, Elaine Angelino
> <elaine.angelino@gmail.com> 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
> to
> > produce the final output (see
> >
> http://projects.scipy.org/numpy/wiki/CodingStyleGuidelines#docstring-standard
> ).
> >
> > Are these Numpy pre-processors available to the community?  I would love
> to
> > use them!
>
> http://svn.scipy.org/svn/numpy/trunk/doc/sphinxext/
>
> --
> 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
> NumPy-Discussion@scipy.org
> http://mail.scipy.org/mailman/listinfo/numpy-discussion
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://mail.scipy.org/pipermail/numpy-discussion/attachments/20090921/ec14439b/attachment.html 


More information about the NumPy-Discussion mailing list