reStructuredText style demo

This is a simple demo of a subset of reStructuredText features.

Inline markup

The quick brown fox jumps over the lazy dog. Title reference.

Lorem ipsum [Ref] dolor sit amet.

[Ref]Book or article reference, URL or whatever.

Lorem ipsum [1] dolor sit amet ... [2]

Footnotes

[1]Text of the first footnote.
[2]Text of the second footnote.

Lists and quote-like blocks

  • Bulleted list
  • with two items
  1. Numbered list
  2. with
  3. three items
  • Nested

    1. List
    • Hooray
    • Hooray
    • Hooray
    • Hooray
    1. List
    • Hooray
    • Hooray
    • Hooray
    • Hooray
  • Nested

    1. List
term (up to a line of text)

Definition of the term, which must be indented

and can even consist of multiple paragraphs

next term
Description.

Paragraph heading

(The above ToC triggers anchors around all page headings beyond what Sphinx does.)

Topic

A topic is like a block quote with a title, or a self-contained section with no subsections. Use the “topic” directive to indicate a self-contained idea that is separate from the flow of the document. Topics may occur anywhere a section or transition may occur. Body elements and topics may not contain nested topics.

parsed-literal is a literal-looking block with parsed text

Epigraph

No matter where you go, there you are.

—Buckaroo Banzai

Compound paragraph

This is a compound paragraph. 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.

Raw HTML

This is some raw HTML.

Admonition blocks

Attention

attention block block block block block block block block block block block

Caution

caution block

Danger

danger block

Error

error block

Hint

hint block

Important

important block

Note

note block

Tip

tip block

Warning

warning block

custom admonition

with content