[Numpy-discussion] [SciPy08] Documentation BoF

Robert Kern robert.kern@gmail....
Sun Aug 24 17:21:05 CDT 2008


On Sun, Aug 24, 2008 at 15:05, Ondrej Certik <ondrej@certik.cz> wrote:
> Currently sphinx can't handle scipy docstrings, can it? It didn't for
> me at least. It'd be nice if whatever format you agre upon, could work
> with sphinx's autodoc.

We do some preprocessing, I believe.

> Also I am very interested in your web based editing of docstrings, so
> that people can just fix and improve the docstrings easily. I can
> imagine something like
>
> In [1]: e.series???
>
> in ipython and it would fireup a browser pointing to the docstring and
> one would just fix it. Since you did most of the work already, maybe
> the above won't be that hard to do either.

The idea of having a this_docstring_sucks() function was certainly
bounced around at the BoF.
:-)

-- 
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