reStructuredText & Sphinx

This chapter is an introduction and reference for writing documentation using reStructuredText (also referred to as reST) and Sphinx.

It is recommended to read (or at least browse through) the Introduction and the general Coding guidelines for reST files first.

Also read Common pitfalls in order to avoid common mistakes with the syntax or make sure to setup your editor or IDE correctly to detect and show errors in the syntax.

You don't need to read the entire chapter, just lookup the section that is relevant for what you plan to do.

Or, use the Cheat sheet: reST & Sphinx, which contains the most commonly used markup on one page.

We won't be covering every reST markup that is available. For more information, see other resources, such as:


See the t3SphinxThemeRtd demo docs for more examples.