Differences between revisions 4 and 5
⇤ ← Revision 4 as of 2005-04-28 08:26:09 →
Size: 700
Editor: dyn176202
Comment:
← Revision 5 as of 2005-04-28 08:27:37 → ⇥
Size: 538
Editor: dyn176202
Comment:
Deletions are marked like this. Additions are marked like this.
Line 3: Line 3:
The purpose of the Docutils project is to create a set of tools for
processing plaintext documentation into useful formats, such as HTML,
XML, and LaTeX. Includes reStructuredText_, the easy to read, easy to
use, what-you-see-is-what-you-get plaintext markup language. Several
sources are or will be supported:

- Standalone files (implemented).
- Inline documentation from Python modules and packages, extracted
  with namespace context.
- `PEPs (Python Enhancement Proposals)`_ (implemented).
- And others as discovered.		 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 stand-alone documents. !ReStructuredText is designed for extensibility for specific application domains. reStructuredText_ is a revision and re-interpretation of the !StructuredText and Setext lightweight markup systems.
Line 17: Line 7:
.. _PEPs:
.. _PEPs (Python Enhancement Proposals): http://www.python.org/peps/
Rendering of reStructured text is not possible, please install Docutils.

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 stand-alone documents. !ReStructuredText is designed for extensibility for specific application domains. reStructuredText_ is a revision and re-interpretation of the !StructuredText and Setext lightweight markup systems.


.. _reStructuredText: http://docutils.sourceforge.net/rst.html

JunHu: JunHu/Memo/ReStructuredText (last edited 2008-10-03 20:19:42 by localhost)