reStructuredText Test Document

1.1 Section Title

Section Subtitle

Lone subsections are converted to a section subtitle by a transform activated with the --section-subtitles command line option or the sectsubtitle-xform configuration value.

1.2 Empty Section

1.3 Transitions

Here's a transition:

It divides the section. Transitions may also occur between sections:

2.1 Paragraphs

A paragraph.

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.

  • This nested list should be compacted by the HTML writer.

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

2.4 Definition Lists

Term

Definition

Termclassifier

Definition paragraph 1.

Definition paragraph 2.

Term

Definition

Termclassifier oneclassifier two

Definition

2.5 Field Lists

what:

Field lists map field names to field bodies, like database records. They are often part of an extension syntax. They are an unambiguous variant of RFC 2822 fields.

how arg1 arg2:

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.

credits:

This paragraph has the credits class set. (This is actually not about credits but just for ensuring that the class attribute doesn't get stripped away.)

2.6 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, too

--input=file

long options can also have arguments

/V

DOS/VMS-style option

--very-long-option

The description can also start on the next line.

The description may contain multiple body elements, regardless of where it starts.

-x, -y, -z

Multiple options are an "option group".

-v, --verbose

Commonly-seen: short & long options.

-1 file, --one=file, --two file

Multiple options with arguments.

-f <[path]file>

Option argumens must start with a letter or be wrapped in angle brackets.

-d <src dest>

Angle brackets are also required if an option expects more than one argument.

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

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?

2.8 Line Blocks

This section tests line blocks. Line blocks are body elements which consist of lines and other line blocks. Nested line blocks cause indentation.

Another line block, surrounded by paragraphs:

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...

A line block, like the following poem by Christian Morgenstern, can also be centre-aligned:

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)

The language of a quote (like any other object) can be specified by a class attribute:

ReStructuredText est un langage de balisage léger utilisé notamment dans la documentation du langage Python.

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)

2.11 Footnotes

2.12 Citations

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

2.13 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 [7]".

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.

2.14 Directives

These are just a sample of the many reStructuredText Directives. For others, please see reStructuredText Directives [15].

2.14.2 Images and Figures

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

Image with multiple IDs:

A centered image:

A left-aligned image:

This paragraph might flow around the image. The specific behavior depends upon the style sheet and the browser or rendering software used.

A right-aligned image:

This paragraph might flow around the image. The specific behavior depends upon the style sheet and the browser or rendering software used.

For inline images see Substitution Definitions.

Image size:

An image 2 em wide:

An image 2 cm wide and 15 pixel high:

Relative units allow adaption of the image to the screen or paper size. An image occupying 50% of the line width:

A figure is an image with a caption and/or a legend. With page-based output media, figures might float to a different position if this helps the page layout.

A left-aligned figure, 70% wide:

This paragraph might flow around the figure.

The specific behavior depends upon the style sheet and the browser or rendering software used.

A centred figure, 40% wide:

This paragraph might flow around the figure.

The specific behavior depends upon the style sheet and the browser or rendering software used.

A right-aligned figure:

This paragraph might flow around the figure. The specific behavior depends upon the style sheet and the browser or rendering software used.

2.14.8 Compound Paragraph

The compound directive is used to create a "compound paragraph", which is a single logical paragraph containing multiple physical body elements. For example:

The 'rm' command is very dangerous. If you are logged in as root and enter

cd /
rm -rf *

you will erase the entire contents of your file system.

Test the handling and display of compound paragraphs:

Compound 2, paragraph 1,

compound 2, paragraph 2,

• list item 1,

• list item 2,

compound 2, paragraph 3.

Compound 3, only consisting of one paragraph.

Compound 4.
This one starts with a literal block.

Compound 4, paragraph following the literal block.

Now something really perverted -- a nested compound block. This is just to test that it works at all; the results don't have to be meaningful.

Compound 5, block 1 (a paragraph).

Compound 6 is block 2 in compound 5.

Compound 6, another paragraph.

Compound 5, block 3 (a paragraph).

Compound 7, tests the inclusion of various block-level elements in one logical paragraph. First a table,

Left cell, first paragraph. Left cell, second paragraph.

Middle cell, consisting of exactly one paragraph.

Right cell. Paragraph 2. Paragraph 3.

followed by a paragraph. This physical paragraph is actually a continuation of the paragraph before the table. It is followed by

a quote and

1. an enumerated list,

a paragraph,

--an

option list,

a paragraph,

a field:

list,

a paragraph,

a definition

list,

a paragraph, an image:

a paragraph,

a line

block,

a paragraph followed by a comment,

a paragraph, a

and the final paragraph of the compound 7.

This is a parsed literal block.
    This line is indented.  The next line is blank.

Inline markup is supported, e.g. emphasis, strong, literal
text, sub- and superscripts,
inline formulas: A = 2πr2,
footnotes [1], hyperlink targets, and references.

print 'This is Python code.'

 8 # print integers from 0 to 9:
 9 for i in range(10):
10     print i

1 .. header:: Document header
2 .. footer:: Document footer

2.15 Substitution Definitions

An inline image () example:

A Unicode example:

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

2.16 Comments

Here's one:

(View the HTML source to see the comment.)

2.17 Raw text

This does not necessarily look nice, because there may be missing white space.

It's just there to freeze the behavior.

This is the fourth test with myrawroleclass set.

2.18 Container

2.19 Colspanning tables

This table has a cell spanning two columns:

2.20 Rowspanning tables

Here's a table with cells spanning several rows:

2.21 Complex tables

Here's a complex table, which should test all features.

2.22 List Tables

Here's a list table exercising all features:

2.23 Custom Roles

• A role based on an existing role.

  one two three

• A new role.

  one two three

• A role with class attribute.

  interpreted text

• A language-switching role:

  Let's count in German eins zwei drei.

• A role with multiple class attributes, styled with raw directives:

  The following works in most browsers but does not validate (<style> is only allowed in the document head):

  .. raw:: html
  
    <style type="text/css"><!--
     .green {color: green;}
     .sc {font-variant: small-caps;}
     --></style>

  British colourful text in small-caps.

3.1 Field List Rendering

A field list is converted to a HTML definition list and given the field-list class argument value to allow CSS styling. With html_plain.css, the layout is similar to html4css1:

A long field name:

sticks into the field body.

The field body is pushed to the next line (you can suppress this behaviour with the run-in class argument).

Customization:

of the field name width is possible with CSS instead of the field-name-limit configuration setting, for example:

dl.field-list > dd { margin-left: 6em; }

Empty:

fields:

must not lead to misalignment of the following content.

3.2 Styling with Class Arguments

The plain.css style sheet comes with some pre-defined style variants that can be chosen via a class argument.

3.3 Text-Level Semantics

This section describes the HTML 5 tags for representation of text-level semantics [19] and their reStructuredText equivalents.

a

Hyperlinks

Visit my drinks page.

em

Stress emphasis

I must say I adore lemonade. I's sooo sweet.

strong

Importance

Warning: This tea is very hot.

small

Side comments

These grapes are made into wine. Alcohol is addictive.

s

Inaccurate text

Price: £4.50 £2.00!

cite

Titles of works

The case Hugo v. Danielle is relevant here. I recommend reading Harry Potter.

q

Quotations

The judge said You can drink water from the fish tank but advised against it.

dfn

Defining instance

The term organic food refers to food produced without synthetic chemicals.

abbr

Abbreviations [5]

Organic food in Ireland is certified by the IOFGA [‡]

In rST there are separate roles for abbreviations rsp. acronymes. In HTML, the <acronym> tag is obsolete and authors are advised to use <abbr> instead. The HTML5 writer uses <abbr> for Docutil's <abbreviation> element.

ruby, rt, rp

Ruby annotations

Require inline nesting, currently not supported in rST.

data

Machine-readable equivalent [6]

time

Machine-readable equivalent of date- or time-related data [6]

code

Computer code

The fruitdb program can be used for tracking fruit production.

var

Variables

If there are n fruit in the bowl, at least n÷2 will be ripe.

samp

Computer output

The computer said Unknown error -3.

kbd

User input

Hit F1 to continue.

sub

Subscripts

Water is H₂O.

sup

Superscripts

The Hydrogen in heavy water is usually ²H.

i

Alternative voice

Lemonade consists primarily of Citrus limon.

b

Keywords

Take a lemon and squeeze it with a juicer.

u

Annotations

The mixture of apple juice and eldeflower juice is very pleasant.

mark

Highlight

Elderflower cordial, with one part cordial to ten parts water, stands apart from the rest.

bdi

Text directionality isolation [5]

The recommended restaurant is My Juice Café (At The Beach).

The dir global attribute defaults to "auto" (not "inherit") on this element.

bdo

Text directionality formatting [6]

Authors must specify the dir attribute on this element.

span

Other

In French we call it sirop de sureau.

br

Line break

For complete paragraphs, use a line-block:

Simply Orange Juice Company

Apopka, FL 32703

U.S.A.

rST does not natively support an exceptional hard line break in a floating paragraph. You may use a HTML-only substitution.

I want to break this line after the colon:
but allow other linebreaks in this paragraph according to the width of the containing block.

wbr

Line breaking opportunity

Not supported by rST. You may use a ZWSP character (u200B), literal or via a substitution.

www.simply​​​orange​juice.com

3.4 Indicating Edits

The HTML tags for representation of edits to the document [20] and their reStructuredText equivalents are:

ins

Additions [5]

This text has "always" been here. This text has been inserted.

This paragraph has been inserted.

del

Removed content [5]

This text has been deleted, here is the rest of the paragraph.

This paragraph has been deleted.

3.5 SVG Images

Scalable vector graphics (SVG) images are the only standards-compatible way to include vector graphics in HTML documents. However, they are not supported by all backends/output formats (LaTeX, e.g., supports the PDF or Postscript formats for vector graphics instead). Rendering behaviour varies, depending on the SVG image itself, the method used to put the image in the document, and the viewing agent.

All up-to-date HTML browsers support SVG, however not all do this fully and in the same manner. Some older browsers, especially IE < 9, have deficiencies or require plug-ins (i.e. don't support the <img> tag). Older versions of webkit based browsers (chromium, safari, midori, konqueror) support the <img> tag but don't display contained bitmap images.

The "html4css1" writer includes SVG images as <object> elements, the "html5" writer uses <svg> for embedded images and <img> else. The element type influences several aspects of image behaviour:

• Due to security/privacy considerations, browsers may block <object> data from 3rd party sources.

• If an image is included as <object> or <svg>, it depends on the viewBox declaration of the root <svg> element whether it is scaled or clipped/padded. Images in <img> elements are always scaled.

  

  Image with viewBox, 1.2 em high, left aligned and inline.

  

  Image with viewBox, 5 mm x 15 mm.

  

  Image without viewBox, 5 mm x 15 mm.

  

  Image with embedded bitmap and viewBox, 2 em wide.

  

  Image with embedded bitmap without viewBox.

• SVG images with viewBox keep the aspect ratio unless the preserveAspectRatio attribute is "none". The following two images are 25% wide and 1 em high:

  

  Image with viewBox.

  

  Image without viewBox.

  

• Hyperlinks and script actions attached to SVG elements are ignored in images included as <img>. Hyperlinks in images included as <object> are opened in the "object frame". Hyperlinks specified in the rST source (with the :target: directive option) work in <img> and <svg> elements but are ignored in images included as <object> (unless the object is blocked).

  

  Image with a link attached to the upper rectangle; interactive clock and button aligned to the right.

  Embedded interactive SVG images.