What follows is a mixture of restructured text and sphinx markup to illustrate some useful features. Refer to the docutils and sphinx documentation for full resources.
We start out by mentioning a couple of ReST markups which sphinx uses. Both these are in paragraph-mode - they occur as a blank line followed by a line at the same indentation as the previous non-blank line, starting with two periods. They are
text following is ignored till the occurence of the next blank line:
.. commented text here
this sets up a link to this location which is able to be referenced by the :ref: mode below:
.. _link_label_here:
The label to reference is the text link_label_here.
The form of comments and link labels is similar to but different from the whole family of directives. They follow.
/paragraph mode): - a blank line followed by a line at the same indentation as the previous non-blank line, beginning with:
.. directive_name_here::
(Each is followed by two colons.)
Each of these performs an operation on the argument that follows. There may be modifying arguments on subsequent indented lines (before any blank lines) which take the form:
:modification: modification_argument
See for example the form of equation-numbered math-equations and csv-tables.
(inline mode): - of the form:
:role_name_here:`text to be interpreted here`
Role names include: