Author chris.jerdonek
Recipients asvetlov, brett.cannon, chris.jerdonek, docs@python, eli.bendersky, eric.araujo, ezio.melotti, georg.brandl, r.david.murray, sbt, terry.reedy, v+python
Date 2012-09-11.03:42:26
SpamBayes Score -1.0
Marked as misclassified Yes
Message-id <1347334947.35.0.170926497914.issue15629@psf.upfronthosting.co.za>
In-reply-to
Content
> Sphinx does have a way to mark doctest snippets as "run this", "don't run this".  I believe that requires using 'make doctest' as the runner,

The doctest module supports this natively (i.e. without the need for Sphinx) via its "skip" directive ("#doctest: +SKIP"):

http://docs.python.org/dev/library/doctest.html#doctest.SKIP

Sphinx will even hide doctest directives like this when rendering the HTML, so the additional annotation won't be visible to the end user/reader and clutter up the interactive examples (cf. issue 12947).

Also, it looks like the Sphinx "doctest" directive gets most or all of its functionality via the options already exposed by doctest:

http://sphinx.pocoo.org/ext/doctest.html?#directive-doctest
History
Date User Action Args
2012-09-11 03:42:27chris.jerdoneksetrecipients: + chris.jerdonek, brett.cannon, georg.brandl, terry.reedy, ezio.melotti, eric.araujo, v+python, r.david.murray, eli.bendersky, asvetlov, docs@python, sbt
2012-09-11 03:42:27chris.jerdoneksetmessageid: <1347334947.35.0.170926497914.issue15629@psf.upfronthosting.co.za>
2012-09-11 03:42:26chris.jerdoneklinkissue15629 messages
2012-09-11 03:42:26chris.jerdonekcreate