mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
25 lines
574 B
ReStructuredText
25 lines
574 B
ReStructuredText
.. _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 reST. For the
|
|
authoritative reStructuredText reference, refer to the `docutils
|
|
documentation`__.
|
|
|
|
__ https://docutils.sourceforge.io/rst.html
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
basics
|
|
roles
|
|
directives
|
|
field-lists
|
|
domains
|