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.


  • shortened to “para” and corresponds to <p> HTML tag

  • are basic processing “units”, e.g. for translattion

  • paragraph is created by blank line

  • do long single-lined paras (easier diffs in Git)

Blank line creates paragraphs


1This is the first paragraph
2written on multiple lines
4The second paragraph begins
5after a blank line.

This is the first paragraph written on multiple lines

The second paragraph begins after a blank line.

Previous: note | Next: parsed-literal-block