You are viewing the latest unreleased documentation v3.2.dev0. You may prefer a stable version.

reST Quick Start

reST is used to create the documentation for Iris. It is used to author all of the documentation content including use in docstrings where appropriate. For more information see Docstrings.

reST is a lightweight markup language intended to be highly readable in source format. This guide will cover some of the more frequently used advanced reST markup syntaxes, for the basics of reST the following links may be useful:

Reference documentation for reST can be found at http://docutils.sourceforge.net/rst.html.