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
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
|
Basic Specification
=================================
Paragraphs contain text and may contain inline markup: *emphasis*, **strong emphasis**, `interpreted text`, ``inline literals``, standalone hyperlinks (http://www.python.org), external hyperlinks (Python_), internal cross-references (example_), footnote references ([1]_), citation references ([CIT2002]_), substitution references (|example|), and _`inline internal targets`.
Table of contents
-----------------
.. contents::
.. |example| replace:: foo **bar**
List
----
Bullet lists:
```````````````
- This is a bullet list.
- Bullets can be "*", "+", or "-".
Enumerated lists:
``````````````````
1. This is an enumerated list.
2. Enumerators may be arabic numbers, letters, or roman
numerals.
Definition lists:
``````````````````
what
Definition lists associate a term with a definition.
how
The term is a one-line phrase, and the definition is one
or more paragraphs or body elements, indented relative to
the term.
Field lists:
````````````
:what: Field lists map field names to field bodies, like
database records. They are often part of an extension
syntax.
:how: The field marker is a colon, the field name, and a
colon.
The field body may contain one or more body elements,
indented relative to the field marker.
Option lists, for listing command-line options:
``````````````````````````````````````````````````````````
-a command-line option "a"
-b file options can have arguments
and long descriptions
--long options can be long also
--input=file long options can also have
arguments
/V DOS/VMS-style options too
Literal blocks:
-------------------
if literal_block:
text = 'is left as-is'
spaces_and_linebreaks = 'are preserved'
markup_processing = None
Block quotes:
----------------
This theory, that is mine, is mine.
-- Anne Elk (Miss)
Simple Table
-----------------
==================== ========== ==========
Header row, column 1 Header 2 Header 3
==================== ========== ==========
body row 1, column 1 column 2 column 3
body row 2 Cells may span columns
==================== ======================
Citation
------------
.. [1] A footnote contains body elements, consistently
indented by at least 3 spaces.
.. [CIT2002] Just like a footnote, except the label is
textual.
Internal reference
------------------
.. _example:
The "_example" target above points to this paragraph.
.. _Python: http://www.python.org
|
