[Numpy-discussion] something wrong with docs?

Pauli Virtanen pav+sp@iki...
Tue Sep 22 02:02:40 CDT 2009


Mon, 21 Sep 2009 18:49:47 -0700, Fernando Perez wrote:

> On Mon, Sep 21, 2009 at 11:32 AM, Pauli Virtanen <pav@iki.fi> wrote:
>> The `sphinx.ext.doctest` extension is not enabled, so the testcode::
>> etc. directives are not available. I'm not sure if it should be enabled
>> -- it would be cleaner to just replace the testcode:: stuff with the
>> ordinary example markup.
>>
>>
> Why not enable it?  It would be nice if we could move gradually towards
> docs whose examples (at least those marked as such) were always run via
> sphinx.  The more we do this, the higher the chances of non-zero overlap
> between documentation and reality :)

I think sphinx.ext.doctest is able to also test the ordinary >>> marked-
up examples, so there'd be no large need for new directives.

But oh well, I suppose enabling it can't hurt much.

-- 
Pauli Virtanen



More information about the NumPy-Discussion mailing list