[Numpy-discussion] numpy docstring sphinx pre-processors
Mon Sep 21 12:15:24 CDT 2009
On Mon, Sep 21, 2009 at 1:08 PM, Robert Kern <firstname.lastname@example.org> wrote:
> On Mon, Sep 21, 2009 at 12:03, Elaine Angelino
> <email@example.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
>> 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
>> Are these Numpy pre-processors available to the community? I would love to
>> use them!
> Robert Kern
I just struggled through the same task, which required some
adjustments to work on Windows. If you want to compare the versions,
the sphinx doc directory of statsmodels is here:
This uses the numpy sphinxext, but requires a very recent sphinx and
doesn't include any older sphinx compatibility, but works almost out
of the box on both windows and linux.
> "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
More information about the NumPy-Discussion