2018-03-29 13:23:39 -04:00
|
|
|
.. _rst-index:
|
|
|
|
|
|
2017-11-03 12:44:39 +00:00
|
|
|
================
|
|
|
|
|
reStructuredText
|
|
|
|
|
================
|
|
|
|
|
|
|
|
|
|
reStructuredText (reST) is the default plaintext markup language used by both
|
|
|
|
|
Docutils and Sphinx. Docutils provides the basic reStructuredText syntax, while
|
|
|
|
|
Sphinx extends this to support additional functionality.
|
|
|
|
|
|
|
|
|
|
The below guides go through the most important aspects of reST. For the
|
|
|
|
|
authoritative reStructuredText reference, refer to the `docutils
|
|
|
|
|
documentation`__.
|
|
|
|
|
|
|
|
|
|
__ http://docutils.sourceforge.net/rst.html
|
|
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 2
|
|
|
|
|
|
|
|
|
|
basics
|
2017-11-03 13:38:39 +00:00
|
|
|
roles
|
2018-03-21 13:45:01 +00:00
|
|
|
directives
|
2017-11-03 14:35:20 +00:00
|
|
|
field-lists
|
2017-11-03 20:20:36 +00:00
|
|
|
domains
|
