1
.. This is a comment. Note how any initial comments are moved by
2
transforms to after the document title, subtitle, and docinfo.
4
================================
5
reStructuredText Demonstration
6
================================
8
.. Above is the document title, and below is the subtitle.
9
They are transformed from section titles after parsing.
11
--------------------------------
12
Examples of Syntax Constructs
13
--------------------------------
15
.. bibliographic fields (which also require a transform):
17
:Author: David Goodger
18
:Address: 123 Example Street
21
:Contact: goodger@users.sourceforge.net
22
:Authors: Me; Myself; I
23
:organization: humankind
24
:date: $Date: 2005-07-15 15:38:57 +0200 (Fri, 15 Jul 2005) $
25
:status: This is a "work in progress"
26
:revision: $Revision: 3756 $
28
:copyright: This document has been placed in the public domain. You
29
may do with it as you wish. You may copy, modify,
30
redistribute, reattribute, sell, buy, rent, lease,
31
destroy, or improve it, quote it at length, excerpt,
32
incorporate, collate, fold, staple, or mutilate it, or do
33
anything else to it that your or anyone else's heart
35
:field name: This is a generic bibliographic field.
37
Generic bibliographic fields may contain multiple body elements.
43
For Docutils users & co-developers.
47
This document is a demonstration of the reStructuredText markup
48
language, containing examples of all basic reStructuredText
49
constructs and many advanced constructs.
52
:keywords: reStructuredText, demonstration, demo, parser
53
:description lang=en: A demonstration of the reStructuredText
54
markup language, containing examples of all basic
55
constructs and many advanced constructs.
57
.. contents:: Table of Contents
58
.. section-numbering::
67
That's it, the text just above this line.
76
It divides the section.
89
Paragraphs contain text and may contain inline markup: *emphasis*,
90
**strong emphasis**, ``inline literals``, standalone hyperlinks
91
(http://www.python.org), external hyperlinks (Python_), internal
92
cross-references (example_), external hyperlinks with embedded URIs
93
(`Python web site <http://www.python.org>`__), footnote references
94
(manually numbered [1]_, anonymous auto-numbered [#]_, labeled
95
auto-numbered [#label]_, or symbolic [*]_), citation references
96
([CIT2002]_), substitution references (|example|), and _`inline
97
hyperlink targets` (see Targets_ below for a reference back to here).
98
Character-level inline markup is also possible (although exceedingly
99
ugly!) in *re*\ ``Structured``\ *Text*. Problems are indicated by
100
|problematic| text (generated by processing errors; this one is
103
The default role for interpreted text is `Title Reference`. Here are
104
some explicit interpreted text roles: a PEP reference (:PEP:`287`); an
105
RFC reference (:RFC:`2822`); a :sub:`subscript`; a :sup:`superscript`;
106
and explicit roles for :emphasis:`standard` :strong:`inline`
109
.. DO NOT RE-WRAP THE FOLLOWING PARAGRAPH!
111
Let's test wrapping and whitespace significance in inline literals:
112
``This is an example of --inline-literal --text, --including some--
113
strangely--hyphenated-words. Adjust-the-width-of-your-browser-window
114
to see how the text is wrapped. -- ---- -------- Now note the
115
spacing between the words of this sentence (words
116
should be grouped in pairs).``
118
If the ``--pep-references`` option was supplied, there should be a
119
live link to PEP 258 here.
126
+ Nested bullet list.
131
Paragraph 2 of item 2.
133
* Nested bullet list.
154
2. Lists that don't start at 1:
168
#. List items may also be auto-enumerated.
176
Definition paragraph 1.
178
Definition paragraph 2.
185
:what: Field lists map field names to field bodies, like database
186
records. They are often part of an extension syntax. They are
187
an unambiguous variant of RFC 2822 fields.
191
The field marker is a colon, the field name, and a colon.
193
The field body may contain one or more body elements, indented
194
relative to the field marker.
199
For listing command-line options:
201
-a command-line option "a"
202
-b file options can have arguments
203
and long descriptions
204
--long options can be long also
205
--input=file long options can also have
209
The description can also start on the next line.
211
The description may contain multiple body elements,
212
regardless of where it starts.
214
-x, -y, -z Multiple options are an "option group".
215
-v, --verbose Commonly-seen: short & long options.
216
-1 file, --one=file, --two file
217
Multiple options with arguments.
218
/V DOS/VMS-style options too
220
There must be at least two spaces between the option and the
226
Literal blocks are indicated with a double-colon ("::") at the end of
227
the preceding paragraph (over there ``-->``). They can be indented::
230
text = 'is left as-is'
231
spaces_and_linebreaks = 'are preserved'
232
markup_processing = None
234
Or they can be quoted without indentation::
238
> Why didn't I think of that?
243
| This is a line block. It ends with a blank line.
244
| Each new line begins with a vertical bar ("|").
245
| Line breaks and initial indents are preserved.
246
| Continuation lines are wrapped portions of long lines;
247
they begin with a space in place of the vertical bar.
248
| The left edge of a continuation line need not be aligned with
249
the left edge of the text above it.
251
| This is a second line block.
253
| Blank lines are permitted internally, but they must begin with a "|".
255
Take it away, Eric the Orchestra Leader!
257
| A one, two, a one two three four
259
| Half a bee, philosophically,
260
| must, *ipso facto*, half not be.
261
| But half the bee has got to be,
262
| *vis a vis* its entity. D'you see?
264
| But can a bee be said to be
265
| or not to be an entire bee,
266
| when half the bee is not a bee,
267
| due to some ancient injury?
274
Block quotes consist of indented body elements:
276
My theory by A. Elk. Brackets Miss, brackets. This theory goes
277
as follows and begins now. All brontosauruses are thin at one
278
end, much much thicker in the middle and then thin again at the
279
far end. That is my theory, it is mine, and belongs to me and I
280
own it, and what it is too.
287
>>> print 'Python-specific usage examples; begun with ">>>"'
288
Python-specific usage examples; begun with ">>>"
289
>>> print '(cut and pasted from interactive Python sessions)'
290
(cut and pasted from interactive Python sessions)
295
Here's a grid table followed by a simple table:
297
+------------------------+------------+----------+----------+
298
| Header row, column 1 | Header 2 | Header 3 | Header 4 |
299
| (header rows optional) | | | |
300
+========================+============+==========+==========+
301
| body row 1, column 1 | column 2 | column 3 | column 4 |
302
+------------------------+------------+----------+----------+
303
| body row 2 | Cells may span columns. |
304
+------------------------+------------+---------------------+
305
| body row 3 | Cells may | - Table cells |
306
+------------------------+ span rows. | - contain |
307
| body row 4 | | - body elements. |
308
+------------------------+------------+----------+----------+
309
| body row 5 | Cells may also be | |
310
| | empty: ``-->`` | |
311
+------------------------+-----------------------+----------+
327
.. [1] A footnote contains body elements, consistently indented by at
330
This is the footnote's second paragraph.
332
.. [#label] Footnotes may be numbered, either manually (as in [1]_) or
333
automatically using a "#"-prefixed label. This footnote has a
334
label so it can be referred to from multiple places, both as a
335
footnote reference ([#label]_) and as a hyperlink reference
338
.. [#] This footnote is numbered automatically and anonymously using a
341
.. [*] Footnotes may also use symbols, specified with a "*" label.
342
Here's a reference to the next footnote: [*]_.
344
.. [*] This footnote shows the next symbol in the sequence.
346
.. [4] Here's an unreferenced footnote, with a reference to a
347
nonexistent footnote: [5]_.
352
.. [CIT2002] Citations are text-labeled footnotes. They may be
353
rendered separately and differently from footnotes.
355
Here's a reference to the above, [CIT2002]_, and a [nonexistent]_
363
This paragraph is pointed to by the explicit "example" target. A
364
reference can be found under `Inline Markup`_, above. `Inline
365
hyperlink targets`_ are also possible.
367
Section headers are implicit targets, referred to by name. See
368
Targets_, which is a subsection of `Body Elements`_.
370
Explicit external targets are interpolated into references such as
373
.. _Python: http://www.python.org/
375
Targets may be indirect and anonymous. Thus `this phrase`__ may also
376
refer to the Targets_ section.
380
Here's a `hyperlink reference without a target`_, which generates an
383
Duplicate Target Names
384
``````````````````````
386
Duplicate names in section headers or other implicit targets will
387
generate "info" (level-1) system messages. Duplicate names in
388
explicit targets will generate "warning" (level-2) system messages.
390
Duplicate Target Names
391
``````````````````````
393
Since there are two "Duplicate Target Names" section headers, we
394
cannot uniquely refer to either of them by name. If we try to (like
395
this: `Duplicate Target Names`_), an error is generated.
400
.. contents:: :local:
402
These are just a sample of the many reStructuredText Directives. For
404
http://docutils.sourceforge.net/docs/ref/rst/directives.html.
409
An example of the "contents" directive can be seen above this section
410
(a local, untitled table of contents_) and at the beginning of the
411
document (a document-wide `table of contents`_).
416
An image directive (also clickable -- a hyperlink reference):
418
.. image:: images/title.png
423
.. figure:: images/title.png
424
:alt: reStructuredText, the markup syntax
426
A figure is an image with a caption and/or a legend:
428
+------------+-----------------------------------------------+
429
| re | Revised, revisited, based on 're' module. |
430
+------------+-----------------------------------------------+
431
| Structured | Structure-enhanced text, structuredtext. |
432
+------------+-----------------------------------------------+
433
| Text | Well it is, isn't it? |
434
+------------+-----------------------------------------------+
436
This paragraph is also part of the legend.
441
.. Attention:: Directives at large.
445
Don't take any wooden nickels.
447
.. DANGER:: Mad scientist at work!
449
.. Error:: Does not compute.
451
.. Hint:: It's bigger than a bread box.
454
- Wash behind your ears.
455
- Clean up your room.
459
.. Note:: This is a note.
461
.. Tip:: 15% if the service is good.
463
.. WARNING:: Strong prose may provoke extreme mental exertion.
464
Reader discretion is strongly advised.
466
.. admonition:: And, by the way...
468
You can make up your own admonition too.
470
Topics, Sidebars, and Rubrics
471
`````````````````````````````
473
.. sidebar:: Sidebar Title
474
:subtitle: Optional Subtitle
476
This is a sidebar. It is for text outside the flow of the main
479
.. rubric:: This is a rubric inside a sidebar
481
Sidebars often appears beside the main text with a border and
484
.. topic:: Topic Title
488
.. rubric:: This is a rubric
498
I recommend you try |Python|_.
500
.. |Python| replace:: Python, *the* best language around
507
This paragraph contains a literal block::
510
Transmitting data... OK
513
and thus consists of a simple paragraph, a literal block, and
514
another simple paragraph. Nonetheless it is semantically *one*
517
This construct is called a *compound paragraph* and can be produced
518
with the "compound" directive.
520
Substitution Definitions
521
------------------------
523
An inline image (|example|) example:
525
.. |EXAMPLE| image:: images/biohazard.png
527
(Substitution definitions are not visible in the HTML source.)
534
.. Comments begin with two dots and a space. Anything may
535
follow, except for the syntax of footnotes, hyperlink
536
targets, directives, or substitution definitions.
538
Double-dashes -- "--" -- must be escaped somehow in HTML output.
540
(View the HTML source to see the comment.)
545
Any errors caught during processing will generate system messages.
547
|*** Expect 6 errors (including this one). ***|
549
There should be six messages in the following, auto-generated
550
section, "Docutils System Messages":
552
.. section should be added by Docutils automatically
added
removed
docs/user/rst/demo.txt
