Mastering Object-Oriented Python - Second Edition

RST directives

RST also includes directives. A directive is written in a block that starts with ... A directive may contain content that's indented. It may also have parameters. RST has a large number of directives that we might use to create a more sophisticated document. For docstring preparation, we'll rarely use more than a few of the directives available. The directives are open-ended; tools such as Sphinx will add directives to produce more sophisticated documentation.

Three commonly used directives are image, csv-table, and math. If we have an image that should be part of our document, we might include it in the following way:

..  image:: media/some_file.png 
    :width: 6in 

We named the file media/some_file.png. We also provided it with ...