1.1.1.1.1   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.1.2.1.1   Inline Markup

Paragraphs contain text and may contain inline markup: emphasis, strong emphasis, inline literals, standalone hyperlinks (http://www.python.org), external hyperlinks (Python [5]), internal cross-references (example), external hyperlinks with embedded URIs (Python web site), anonymous hyperlink references [5] (a second reference [6]), footnote references (manually numbered [1], anonymous auto-numbered [3], labeled auto-numbered [2], or symbolic [*]), citation references (see [CIT2002]), substitution references ( & a trimmed heart (U+2665):♥), and inline hyperlink targets (see Targets below for a reference back to here). Character-level inline markup is also possible (although exceedingly ugly!) in reStructuredText. Problems are indicated by |problematic| text (generated by processing errors; this one is intentional). Here is a reference to the doctitle and the subtitle.

The default role for interpreted text is Title Reference. Here are some explicit interpreted text roles: a PEP reference (PEP 287); an RFC reference (RFC 2822); an abbreviation (abb.), an acronym (reST), code (print "hello world"); a _subscript; a ^superscript and explicit roles for Docutils' standard inline markup.

Let's test wrapping and whitespace significance in inline literals: This is an example of --inline-literal --text, --including some-- strangely--hyphenated-words.  Adjust-the-width-of-your-browser-window to see how the text is wrapped.  -- ---- --------  Now note    the spacing    between the    words of    this sentence    (words should    be grouped    in pairs).

If the --pep-references option was supplied, there should be a live link to PEP 258 here.

1.1.2.13.1   Duplicate Target Names

Duplicate names in section headers or other implicit targets will generate "info" (level-1) system messages. Duplicate names in explicit targets will generate "warning" (level-2) system messages.

1.1.2.13.2   Duplicate Target Names

Since there are two "Duplicate Target Names" section headers, we cannot uniquely refer to either of them by name. If we try to (like this: `Duplicate Target Names`_), an error is generated.

1.1.2.14.1   Document Parts

An example of the "contents" directive can be seen above this section (a local, untitled table of contents) and at the beginning of the document (a document-wide table of contents).

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

Plaintext markup syntax and parser system.

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 left-aligned figure, 70% wide:

This is the caption.

This is the legend.

The legend may consist of several paragraphs.

This paragraph might flow around the figure.

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

A centered figure:

This is the caption.

This is the legend.

The legend may consist of several paragraphs.

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 is the caption.

This is the legend.

The legend may consist of several paragraphs.

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

1.1.2.14.3   Tables

Tables may be given titles and additional arguments with the table directive:

With the "widths" argument "auto" (or "class" value "colwidths-auto"), column widths are determined by the backend (if supported by the writer/backend).

1.1.2.14.4   Admonitions

1.1.2.14.5   Topics, Sidebars, and Rubrics

Sidebars are like miniature, parallel documents.

A topic is like a block quote with a title, or a self-contained section with no subsections.

A rubric is like an informal heading that doesn't correspond to the document's structure. It is typically highlighted in red (hence the name).

This is a rubric

Topics and rubrics can be used at places where a section title is not allowed (e.g. inside a directive).

1.1.2.14.6   Target Footnotes

1.1.2.14.7   Replacement Text

I recommend you try Python, the best language around [5].

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

cd /
rm -rf *

Test the handling and display of compound paragraphs:

Compound 4.
This one starts with a 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 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

Note

with content

and the final paragraph of the compound 7.

1.1.2.14.9   Parsed Literal Blocks

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.

1.1.2.14.10   Code

Blocks of source code can be set with the code directive. If the code language is specified, the content is parsed and tagged by the Pygments_ syntax highlighter and can be formatted with a style sheet. (Code parsing is turned off using the syntax-highlight config setting in the test conversions in order to get identical results with/without installed Pygments highlighter.)

print 'This is Python code.'

The :number-lines: option (with optional start value) generates line numbers:

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

For inline code snippets, there is the code role, which can be used directly (the code will not be parsed/tagged, as the language is not known) or as base for special code roles, e.g. the LaTeX code in the next paragraph.

Docutils uses LaTeX syntax for math directives and roles: \alpha = f(x) prints α = f(x).

1.1.2.14.11   Meta

The “meta” directive [8] is used to specify metadata to be stored in, e.g., HTML META tags or ODT file properties.