Package Documentation

Note

In index.rst you should put some introductory information about your package.

The table of contents (i.e. left sidebar content) is defined in toc.rst.

Keep in mind when writing your documentation you can take advantage of some special features (see Sphinx awesome theme for details). Below are few things you can use.

Admonitions

You can tips, notes, cautions, warnings etc.

rst

.. tip::

   This is how a tip appears.

Tip

This is how a tip appears.

Code Blocks

rst

.. code-block:: python

   import numpy as np

python

import numpy as np