1   reStructuredText Demonstration¶

1.1.1.1   Section Title¶

That’s it, the text just above this line.

1.1.1.2   Transitions¶

Here’s a transition:

It divides the section.

1.1.2.1   Paragraphs¶

A paragraph.

1.1.2.2   Bullet Lists¶

• A bullet list

  • Nested bullet list.
  • Nested item 2.

• Item 2.

  Paragraph 2 of item 2.

  • Nested bullet list.
  • Nested item 2.
    • Third level.
    • Item 2.
  • Nested item 3.

1.1.2.3   Enumerated Lists¶

1. Arabic numerals.

   1. lower alpha)
      1. (lower roman)
         1. upper alpha.
            1. upper roman)

2. Lists that don’t start at 1:

   3. Three
   4. Four
   3. C
   4. D
   3. iii
   4. iv

3. List items may also be auto-enumerated.

1.1.2.4   Definition Lists¶

Term

Definition

Term : classifier

Definition paragraph 1.

Definition paragraph 2.

Term

Definition

1.1.2.5   Field Lists¶

1.1.2.6   Option Lists¶

For listing command-line options:

There must be at least two spaces between the option and the description.

1.1.2.7   Literal Blocks¶

Literal blocks are indicated with a double-colon (”::”) at the end of the preceding paragraph (over there -->). They can be indented:

if literal_block:
    text = 'is left as-is'
    spaces_and_linebreaks = 'are preserved'
    markup_processing = None

Or they can be quoted without indentation:

>> Great idea!
>
> Why didn't I think of that?

1.1.2.8   Line Blocks¶

Take it away, Eric the Orchestra Leader!

A one, two, a one two three four

Half a bee, philosophically,

must, ipso facto, half not be.

But half the bee has got to be,

vis a vis its entity. D’you see?

But can a bee be said to be

or not to be an entire bee,

when half the bee is not a bee,

due to some ancient injury?

Singing...

1.1.2.9   Block Quotes¶

Block quotes consist of indented body elements:

My theory by A. Elk. Brackets Miss, brackets. This theory goes as follows and begins now. All brontosauruses are thin at one end, much much thicker in the middle and then thin again at the far end. That is my theory, it is mine, and belongs to me and I own it, and what it is too.

—Anne Elk (Miss)

1.1.2.10   Doctest Blocks¶

>>> print 'Python-specific usage examples; begun with ">>>"'
Python-specific usage examples; begun with ">>>"
>>> print '(cut and pasted from interactive Python sessions)'
(cut and pasted from interactive Python sessions)

1.1.2.11   Tables¶

Here’s a grid table followed by a simple table:

1.1.2.12   Footnotes¶

1.1.2.13   Citations¶

Here’s a reference to the above, [CIT2002], and a [nonexistent] citation.

1.1.2.14   Targets¶

This paragraph is pointed to by the explicit “example” target. A reference can be found under Inline Markup, above. Inline hyperlink targets are also possible.

Section headers are implicit targets, referred to by name. See Targets, which is a subsection of Body Elements.

Explicit external targets are interpolated into references such as “Python [5]”.

Targets may be indirect and anonymous. Thus this phrase may also refer to the Targets section.

Here’s a `hyperlink reference without a target`_, which generates an error.

1.1.2.15   Directives¶

These are just a sample of the many reStructuredText Directives. For others, please see http://docutils.sourceforge.net/docs/ref/rst/directives.html.

1.1.2.15.2   Images¶

An image directive (also clickable – a hyperlink reference):

A figure directive:

A figure is an image with a caption and/or a legend:

re	Revised, revisited, based on ‘re’ module.
Structured	Structure-enhanced text, structuredtext.
Text	Well it is, isn’t it?

This paragraph is also part of the legend.

A figure directive with center alignment

Connecting... OK
Transmitting data... OK
Disconnecting... OK

1.1.2.16   Substitution Definitions¶

An inline image () example:

(Substitution definitions are not visible in the HTML source.)

1.1.2.17   Comments¶

Here’s one:

(View the HTML source to see the comment.)