Tips for writing code documentation

Tips for the Python documentation (numpy style)

The Pencil Python documentation follows the numpy style docstring convention.

For a thorough example please see the napoleon extension website.

Tip

To make sure sphinx will be successful in generating the documentation, go to the python directory

# from the directory containing conf.py
cd ../../python
python

and try to import the pencil package. If the import succeeds, it is likely that sphinx will also succeed.

Tips for the Fortran documentation

Not yet available.