blob: 5bc19ea8b3fec8f69fbbfacb81ff8f6048ea12d0 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
|
====================
|reStructuredText|
====================
:Date: $Date$
.. contents::
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.
reStructuredText is designed for extensibility for specific
application domains. The reStructuredText parser is a component of
Docutils_. reStructuredText is a revision and reinterpretation of the
StructuredText_ and Setext_ lightweight markup systems.
The primary goal of reStructuredText is to define and implement a
markup syntax for use in Python docstrings and other documentation
domains, that is readable and simple, yet powerful enough for
non-trivial use. The intended purpose of the markup is the conversion
of reStructuredText documents into useful structured data formats.
See statemachine.py_ for an example of a Python module fully
documented using reStructuredText.
User Docs
=========
- `A ReStructuredText Primer`__ (HTML file, or `text source`__).
- `Quick reStructuredText`__ (user reference)
__ docs/rst/quickstart.html
__ docs/rst/quickstart.txt
__ docs/rst/quickref.html
Specification
=============
- `An Introduction to reStructuredText`__
- `reStructuredText Markup Specification`__
- `reStructuredText Directives`__
- `A Record of reStructuredText Syntax Alternatives`__
- `Problems With StructuredText`__
__ spec/rst/introduction.html
__ spec/rst/reStructuredText.html
__ spec/rst/directives.html
__ spec/rst/alternatives.html
__ spec/rst/problems.html
.. _Docutils: index.html
.. _StructuredText:
http://dev.zope.org/Members/jim/StructuredTextWiki/FrontPage/
.. _Setext: mirror/setext.html
.. _statemachine.py: docutils/statemachine.py
.. |reStructuredText| image:: rst.png
..
Local Variables:
mode: indented-text
indent-tabs-mode: nil
sentence-end-double-space: t
fill-column: 70
End:
|
