reStructuredText & Sphinx¶
This chapter is an introduction and reference for writing documentation using reStructuredText (also referred to as reST) and Sphinx.
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 reST & Sphinx cheat sheet, 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: http://openalea.gforge.inria.fr/doc/openalea/doc/_build/html/source/sphinx/rest_syntax.html
See the t3SphinxThemeRtd demo docs for more examples.