"Paddy" <[EMAIL PROTECTED]> wrote in message 
news:[EMAIL PROTECTED]
| On Dec 8, 9:22 pm, Neal Becker <[EMAIL PROTECTED]> wrote:
| > I'm looking for recommendations for writing a user manual.  It will 
need
| > lots of examples of command line inputs and terminal outputs.
| >
| > I'd like to minimize the effort to integrate the terminal input/output 
into
| > my document.  I have lots of experience with latex, but I wonder if 
there
| > may be some other choices.  Maybe docutils, pydoc, something else?  The
| > code I'm documenting is written in python, if that matters.
|
| Doctest and restructuredtext.
| http://docutils.sourceforge.net/docs/user/rst/quickref.html

Doctest is definitely the way to go to test input/output examples.
It can be used with text output from any editor/word processor that 
preserves the example block.  I have used it with .txt versions of an 
OpenOffice .odt file.

The Python docs master copies are, I believe, changing from Latex to RST 
for 2.6.  So that seems like a plausible choice for someone who wants 
visible markup instead of wysiwyg.

tjr






-- 
http://mail.python.org/mailman/listinfo/python-list

Reply via email to