941
Comment: converted to 1.6 markup
|
← Revision 8 as of 2015-01-10 12:22:25 ⇥
945
update link to reStructuredText
|
Deletions are marked like this. | Additions are marked like this. |
Line 11: | Line 11: |
* ReStructuredText - intended primarily for documentation | * [[reStructuredText]] - intended primarily for documentation |
The basic idea behind StructuredText is to avoid the necessity for a markup language like TeX, Troff or HTML/SGML/XML and being able to create richly structured documents without thinking about the markup. The StructuredText markup language is intiutive, minimal and unobtrusive.
There are several different versions of StructuredText:
reStructuredText - intended primarily for documentation
PyTextile - intended for web use
One application of StructuredText which is currently discussed on the DocSig is the generation of documentation from Python DocStrings.
See TextFilter for more information on text filters, like StructuredText. We have a bit of information about StructuredText mark up.