Sphinx and reStructuredText
This section contains more information on the document generation engine Sphinx and reStructuredText markup language.
Structure of a reStructureText File
A typical reStructuredText source file contains a mixture of basic text, light markup elements (headings, tables, lists, etc.), as well as special inline and block markup elements, called roles and directives respectively. This is illustrated in the following figure:
Typical structure of a reStructure.
More information on the various markup elements can be found from the following sources:
Basic syntax and elements such as font style, lists and tables. |
docutils or the rst primer |
Advanced docutils directives. |
|
Additional roles and directives provided by Sphinx. |
|
Additional roles and directives available in rapyds. |