The Python Domain — Sphinx documentation

Sphinx is cray cray:

Inside Python object description directives, reStructuredText field lists with these fields are recognized and formatted nicely:

param, parameter, arg, argument, key, keyword: Description of a parameter.

type: Type of a parameter. Creates a link if possible.

raises, raise, except, exception: That (and when) a specific exception is raised.

var, ivar, cvar: Description of a variable.

vartype: Type of a variable. Creates a link if possible.

returns, return: Description of the return value.

rtype: Return type. Creates a link if possible.

meta: Add metadata to description of the python object. The metadata will not be shown on output document. For example, :meta private: indicates the python object is private member. It is used in sphinx.ext.autodoc for filtering members.