How to do it...

  1. If you just want to include reST in your Python documentation, the following is a quick introduction on how the basic syntax works; at the end are screenshots of how all of these look in practice (a more thorough demonstration is available at http://docutils.sourceforge.net/docs/user/rst/demo.html):
    • The paragraph is the most basic pattern in reST. It is simply a block of text separated from other text blocks by a single, blank line. The blocks must have the same indentation, starting at the left edge. Indenting paragraphs results in offset paragraphs, typically used to show quoted text.
    • Inline markup can be performed by using asterisks, that is, *italics* and **bold**. Monospaced, literal text is denoted with double-backticks: ...

Get Secret Recipes of the Python Ninja now with the O’Reilly learning platform.

O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.