ANN: reStructuredText: markup for docstrings

[David Goodger]

reStructuredText on SourceForge: http://structuredtext.sf.net/

reStructuredText is an easy-to-read, what-you-see-is-what-you-get plaintext
markup syntax and parser system. It is useful for in-line program
documentation (such as Python docstrings), for quickly creating simple web
pages, and for standalone documents. It is a candidate markup
syntax for the Python Docstring Processing System
(http://docstring.sf.net/). So far, the project consists mostly of the
specification (written using reStructuredText, of course!), but I have
started coding the parser.

An example of fully marked-up Python docstrings can be found in the
statemachine.py module (http://docstring.sf.net/dps/statemachine.py). It
implements a finite state machine specialized for regular-expression-based
text filters, and is being used by the reStructuredText parser.

The best place to discuss reStructuredText and other documentation issues is
on the Python Documentation Special Interest Group (Doc-SIG) mailing list:
http://www.python.org/sigs/doc-sig/.

-- 
David Goodger    dgoodger at bigfoot.com    Open-source projects:
 - Python Docstring Processing System: http://docstring.sf.net
 - reStructuredText: http://structuredtext.sf.net
 - The Go Tools Project: http://gotools.sf.net