2018-03-29 12:23:39 -05:00
|
|
|
.. _rst-index:
|
|
|
|
|
|
2017-11-03 07:44:39 -05: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.
|
|
|
|
|
|
2024-07-14 00:00:08 -05:00
|
|
|
The below guides go through the most important aspects of reStructuredText.
|
|
|
|
|
For the authoritative reference, refer to the `docutils documentation`__.
|
2017-11-03 07:44:39 -05:00
|
|
|
|
2021-05-16 07:42:26 -05:00
|
|
|
__ https://docutils.sourceforge.io/rst.html
|
2017-11-03 07:44:39 -05:00
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 2
|
|
|
|
|
|
|
|
|
|
basics
|
2017-11-03 08:38:39 -05:00
|
|
|
roles
|
2018-03-21 08:45:01 -05:00
|
|
|
directives
|
2017-11-03 09:35:20 -05:00
|
|
|
field-lists
|
2023-10-01 12:57:03 -05:00
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
|
:hidden:
|
|
|
|
|
|
|
|
|
|
domains
|
