Lists¶
Enumerated Lists¶
Arabic numerals.
lower alpha)
(lower roman)
upper alpha.
upper roman)
Lists that don’t start at 1:
Three
Four
C
D
iii
iv
List items may also be auto-enumerated.
Definition Lists¶
- Term
Definition
- Termclassifier
Definition paragraph 1.
Definition paragraph 2.
- Term
Definition
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 also
- --input=file
long options can also have arguments
- --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.
- /V
DOS/VMS-style options too
There must be at least two spaces between the option and the description.
Field list¶
- Author
Stuart George
- Address
123 Example Street Example, UK A1B 2C3
- Contact
- Authors
Me; Myself; I
- organization
humankind
- date
$Date: 2012-01-03 19:23:53 +0000 (Tue, 03 Jan 2012) $
- status
This is a “work in progress”
- revision
$Revision: 7302 $
- version
1
- copyright
This document has been placed in the public domain. You may do with it as you wish. You may copy, modify, redistribute, reattribute, sell, buy, rent, lease, destroy, or improve it, quote it at length, excerpt, incorporate, collate, fold, staple, or mutilate it, or do anything else to it that your or anyone else’s heart desires.
- field name
This is a generic bibliographic field.
- field name 2
Generic bibliographic fields may contain multiple body elements.
Like this.
- Dedication
For Docutils users & co-developers.
- abstract
This document is a demonstration of the reStructuredText markup language, containing examples of all basic reStructuredText constructs and many advanced constructs.
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.
inline literall
inline literall
inline literall
Second list level¶
here is a list in a second-level section.
-
here is an inner bullet
oh
one more
with an inline literally
. yahooheh heh. child. try to beat this embed:
1 2 3 4 5 6 7 8 9 10 11 12 13
# -*- coding: utf-8 -*- """Test Module for karma_sphinx_theme.""" class Foo: """Docstring for class Foo. This text tests for the formatting of docstrings generated from output ``sphinx.ext.autodoc``. Which contain reST, but sphinx nests it in the ``<dl>``, and ``<dt>`` tags. Also, ``<tt>`` is used for class, method names and etc, but those will *always* have the ``.descname`` or ``.descclassname`` class.
and another. yahoo
hi
and hehe
Numbered List¶
One,
Two.
Three with long text. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed feugiat sagittis neque quis eleifend. Duis rutrum lectus sit amet mattis suscipit.
Using bullets and letters. (A)
Using bullets and letters. (B)
Using bullets and letters. (C)