Source code documentation

The psysmon source code documentation is done using the Python docstrings formatted by the NumPy/SciPy documentation style. The guide to NumPy/SciPy documentation gives details about the docstring formatting.

Following you will find some useful topics that are frequently used for documenting the source code.

Cross referencing

With Sphinx it's easy to add various cross references to other sphinx documents. Here is a description of the cross referencing.

To cross reference to python objects, there are some useful cross referencing roles: Cross-referencing Python objects.

The docstring tags are :mod:, :func:, :data:, :const:, :class:, :meth:, :attr:, :exc: and :obj.