[Numpy-discussion] numpy docstring sphinx pre-processors

Robert Kern robert.kern@gmail....
Mon Sep 21 12:08:21 CDT 2009


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


More information about the NumPy-Discussion mailing list