Specimen#
This is a demo of reStructuredText and Sphinx features and demonstrates styling of various elements.
Local table of contents
(The above ToC triggers anchors around all page headings beyond what Sphinx does.)
Body copy and inline markup#
The quick brown fox jumps over
the lazy
dog. Title reference. Inline linkes like
https://google.com should work too.
References & footnotes#
References
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 footno |
Lists#
- Bulleted list
- with two items
- Numbered list
- with
- three items
- Nested
- List
- Hooray
- Hooray
- Hooray
- Hooray
- List
- Hooray
- Hooray
- Hooray
- Hooray
- List
- Nested
- List
Definition 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
Options Lists#
-a | command-line option “a” |
-b file | options can have arguments and long descriptions |
--long | options can be long also |
--input=file | long options can also have arguments |
/V | DOS/VMS-style options too |
Blocks#
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.
Topic#
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.
Admonitions#
Debug Note
The default admonition has no colors. It is gray.
Attention
Attention please!
Caution
Attention please!
Danger
This is a danger area.
Error
This is an error message.
Hint
This is hint message.
Important
This is an important message.
Note
This page is showing markup styles, they have no meanings.
Oh. Except this message.
Tip
A small tip please.
Warning
Please don’t do anything harmful to me.
Sphinx Admonitions#
New in version 2.5: The spam parameter.
Changed in version 2.5: The spam parameter.
Deprecated since version 3.1: Use spam()
instead.
See also
It is also available at https://typlog.com/