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 always have the first line of a code listing example as a comment that
gives the name of the file in the comment, but if you had a tag that
required the file name then you could use that to extract the code AND to
create a caption for the example giving the file name.

If this doesn't make sense, I can answer questions. I've been doing this
kind of thing in my books for over 15 years.

-- Bruce Eckel
www.Reinventing-Business.com
www.MindviewInc.com

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