Recommendations for writing a user guide with examples?
Paddy
paddy3118 at googlemail.com
Sun Dec 9 05:55:37 EST 2007
On Dec 8, 9:22 pm, Neal Becker <ndbeck... at gmail.com> 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
- Paddy.
More information about the Python-list
mailing list