Lists

Bulleted

  • Bullets are “-”, “*” or “+”. Continuing text must be aligned after the bullet and whitespace.

    • A blank line before the first and after the last items are required. Blank lines between items are optional.

Example:

- One

- Two
  Multiline

- Three

  Multiparagraph

- Four
  • One

  • Two Multiline

    • Three

      Multiparagraph

  • Four

Horizontal

  • list of

  • short items

  • that should be

  • displayed

  • horizontally

Warning

The order of the list is not the one that you might expect

Example:

.. hlist::
   :columns: 3

   * one
   * two
   * three
   * four

Enumerated

  1. Possible enumerators:

    1. arabic numerals [1, 2,…]

    2. alphabet characters (upper- and lowercase) [a, b,…, A, B,…]

    3. roman numerals (upper- and lowercase) [i, ii,…, I, II,…]

    4. The auto-enumerator #. It can be intercalated with the others.

  2. The enumerator must go with one of the following:

    1. .

    2. )

    3. ()

Example:

3. One
   #. Two
      Multiline

 #. Three

    Multiparagraph

 14. We can alter the
     sequence of the
     numbers
  1. One
    1. Two Multiline

  2. Three

    Multiparagraph

  1. We can alter the sequence of the numbers

Definition

Element

Description

Example:

Element 1
  Description 1

Element 2
  Description 2

  Multiparagraph
Element 1

Description 1

Element 2

Description 2

Multiparagraph

Field

Field id

description

Example:

:Field 1: description can
   also be multiline
:Field 2: another description
Field 1

description can also be multiline

Field 2

another description

Options

-v argument

Description

--o

Description 2

Example:

-v              Option
-v all          Option with value
--verbose       Long option
--verbose=all   Long option with value
-v

Option

-v all

Option with value

--verbose

Long option

--verbose=all

Long option with value

Note that characters within the options are limited. See the reST docs for more details.