reStructuredText is an easy-to-read, what-you-see-is-what-you-get plaintext markup syntax and parser system. It is useful for in-line program documentation (such as Python docstrings), for quickly creating simple web pages, and for standalone documents. reStructuredText is designed for extensibility for specific application domains. The reStructuredText parser is a component of Docutils. reStructuredText is a revision and reinterpretation of the StructuredText and Setext lightweight markup systems.
The primary goal of reStructuredText is to define and implement a markup syntax for use in Python docstrings and other documentation domains, that is readable and simple, yet powerful enough for non-trivial use. The intended purpose of the markup is the conversion of reStructuredText documents into useful structured data formats.
- Official reStructuredText Primer
- Sphinx’s reStructuredText Primer
- Quick reStructuredText, a cheat-sheet
- reStructuredText Goals and History
Goodger, David. 2022. “An Introduction to reStructuredText.” January 21, 2022. https://docutils.sourceforge.io/docs/ref/rst/introduction.html.