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.

• reStructuredText Primer
  • Paragraphs
  • Inline markup
  • Lists and Quote-like blocks
  • Literal blocks
  • Doctest blocks
  • Tables
  • Hyperlinks
  • Sections
  • Field Lists
  • Roles
  • Explicit Markup
  • Directives
  • Images
  • Footnotes
  • Citations
  • Substitutions
  • Comments
  • Source encoding
  • Gotchas
• Roles
  • Cross-referencing syntax
  • Math
  • Other semantic markup
  • Substitutions
• Directives
  • Table of contents
  • Paragraph-level markup
  • Showing code examples
  • Glossary
  • Meta-information markup
  • Index-generating markup
  • Including content based on tags
  • Tables
  • Math
  • Grammar production displays
• Field Lists
  • File-wide metadata
• Domains
  • Basic Markup
  • The Python Domain
  • The C Domain
  • The C++ Domain
  • The Standard Domain
  • The JavaScript Domain
  • The reStructuredText domain
  • The Math Domain
  • More domains