summaryrefslogtreecommitdiffstats
path: root/doc/usage/restructuredtext/index.rst
blob: ada40c52479bbca81762f8443c22233de1dda29f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
.. _rst-index:

================
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 reStructuredText.
For the authoritative reference, refer to the `docutils documentation`__.

__ https://docutils.sourceforge.io/rst.html

.. toctree::
   :maxdepth: 2

   basics
   roles
   directives
   field-lists

.. toctree::
   :hidden:

   domains