On 2012-01-06, Bruce Eckel wrote:

> I'd love to see some kind of tag that indicates that something is, or is
> part of, a working example, so that Sphinx would automatically extract the
> example and it could be downloaded, run, etc.

> I ask for this because I see too much documentation where the author says
> "here's how to do it" and then gives some untested code fragment. I think
> if this (admittedly low, but apparently enough to keep people from doing
> it) hurdle were removed, we'd see far more working examples.

I don't know whether it fits into your work flow, but the PyLit converter
at http://pylit.berlios.de allows to convert a document between "text" and
"code" formats (i.e. rst document with code parts and source code with
comments). This way a complete documentation file can be used at the same
time as a running example, test case, config file, or template.

Günter

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-dev" group.
To post to this group, send email to sphinx-dev@googlegroups.com.
To unsubscribe from this group, send email to 
sphinx-dev+unsubscr...@googlegroups.com.
For more options, visit this group at 
http://groups.google.com/group/sphinx-dev?hl=en.

Reply via email to