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.

Tools and editors

There are plenty of tools for woking with reStructuredText. Also, almost any code editor has reStructuredText files support ranging from simple syntax highlighting to auto-complete, preview, showing errors, linting, etc.

For exahusive list see e.g.,

Online preview

The Snippets ( is online reStructuredText editor can be used to play with the markup and see the results immediately.

Previous: Sphinx and Docutils | Next: Admonitions