reStructuredText and Sphinx Reference

Example based gentle reference of the reStructuredText and Sphinx syntax, directives, roles and common issues. It demonstrates almost all the markup making it also good for testing Sphinx themes. Free and open-source.

Table of Contents

Collections

Admonitions
Body elements
Images
Inline elements
Document parts
Sphinx additions

Elements

admonition
attention
caution
contents
danger
emphasis
error
figure
hint
image
important
inline image
inline literal
note
rubric
section
seealso
sidebar
strong emphasis
subscript
superscript
tip
toctree
topic
transition
warning

Document parts¶

Document part elements constitute overall organization of the document. For example, headings make up sections, topic and sidebar adds point out related information, transition separates text with vertical line.

Previous: Inline elements | Next: Sphinx additions