reStructuredText

Cheatcheat:

Important extensions:

Sections

RST allows to specify a number of sections. You can do this with the various underlines:

*********************
Chapter
*********************
Section
=====================
Subsection
---------------------
Subsubsection
^^^^^^^^^^^^^^^^^^^^^
Paragraph
~~~~~~~~~~~~~~~~~~~~~

Listtable

.. csv-table:: Eye colors
   :header: "Name", "Firstname", "eyes"
   :widths: 20, 20, 10

   "von Laszewski", "Gregor", "gray"
a title
Name Firstname eyes
von Laszewski Gregor gray

Exceltable

we have integrated Excel table from http://pythonhosted.org//sphinxcontrib-exceltable/ intou our sphinx allowing the definition of more elaborate tables specified in excel. Howere the most convenient way may be to use list-tables. The documentation to list tables can be found at http://docutils.sourceforge.net/docs/ref/rst/directives.html#list-table

Boxes

Seealso

.. seealso:: This is a simple **seealso** note.

See also

This is a simple seealso note.

Note

Note

This is a note box.

.. note::  This is a **note** box.

Warning

Warning

note the space between the directive and the text

.. warning:: note the space between the directive and the text

Others

Attention

This is an attention box.

.. attention:: This is an **attention** box.

Caution

This is a caution box.

.. caution:: This is a **caution** box.

Danger

This is a danger box.

.. danger:: This is a **danger** box.

Error

This is a error box.

.. error:: This is a **error** box.

Hint

This is a hint box.

.. hint:: This is a **hint** box.

Important

This is an important box.

.. important:: This is an **important** box.

Tip

This is a tip box.

.. tip:: This is a **tip** box.

Autorun

Autorun is an extension for Sphinx_ that can execute the code from a runblock directive and attach the output of the execution to the document.

For example:

.. runblock:: pycon

    >>> for i in range(3):
    ...    print i

Produces

Another example:

.. runblock:: console

    $ date

Produces

However, when it comes to excersises we do preferthe use of ipython notebooks as this allows us to present them also to users as self contained excersises.

Todo

.. todo:: an example

Todo

an example