[Doc-SIG] Python docs in reST

Fred L. Drake, Jr. fdrake at acm.org
Thu May 26 01:29:46 CEST 2005

On Wednesday 25 May 2005 17:57, Felix Wiemann wrote:
 > * We want to have **well-readable** documentation source.

We have that now.  Not ReST, but its very readable.

 > * We want to get **flexibility** in that we can modify the parsed
 >   document using Python code.

Is this a goal, or is this a means to an end?  This sounds like the later to 

 >   In particular I have Docutils' document tree in mind -- use
 >   rst2pseudoxml.py to see what it looks like.  You can easily apply
 >   transformations on these trees, using your favorite programming
 >   language ;-).  This is not (easily?) possible with LaTeX.

Not easily, but mostly because there are things the markup syntax doesn't 
encode directly.  The handling of paragraphs also doesn't help.

 > * We want an **easy-to-use** documentation system.  Any documentation
 >   should be renderable by typing "sometool.py input.txt output.html".
 >   Getting multi-document output should be similarly easy.

Again, I think we have this now.  "mkhowto input.tex" is pretty 


Fred L. Drake, Jr.   <fdrake at acm.org>

More information about the Doc-SIG mailing list