Directive(name, arguments, options, content, ...) |
Base class for reStructuredText directives. |
Domain(env) |
A Domain is meant to be a group of “object” description directives for objects of a similar nature, and corresponding roles to create references to them. |
Field(name[, names, label, has_arg, ...]) |
A doc field that is never grouped. |
GroupedField(name[, names, label, rolename, ...]) |
A doc field that is grouped; i.e., all fields of that type will be transformed into one field with its body being a bulleted list. |
Index(domain) |
An Index is the description for a domain-specific index. |
ObjType(lname, *roles, **attrs) |
An ObjType is the description for a type of object that a domain can document. |
ObjectDescription(name, arguments, options, ...) |
Directive to describe a class, function or similar object. |
PyClasslike(name, arguments, options, ...) |
Description of a class-like object (classes, interfaces, exceptions). |
PyClassmember(name, arguments, options, ...) |
Description of a class member (methods, attributes). |
PyCurrentModule(name, arguments, options, ...) |
This directive is just to tell Sphinx that we’re documenting stuff in module foo, but links to module foo won’t lead here. |
PyDecoratorFunction(name, arguments, ...) |
Directive to mark functions meant to be used as decorators. |
PyDecoratorMethod(name, arguments, options, ...) |
Directive to mark methods meant to be used as decorators. |
PyDecoratorMixin |
Mixin for decorator directives. |
PyField(name[, names, label, has_arg, ...]) |
|
PyModule(name, arguments, options, content, ...) |
Directive to mark description of a new module. |
PyModulelevel(name, arguments, options, ...) |
Description of an object on module level (functions, data). |
PyObject(name, arguments, options, content, ...) |
Description of a general Python object. |
PyTypedField(name[, names, typenames, ...]) |
|
PyXRefRole([fix_parens, lowercase, ...]) |
|
PyXrefMixin |
|
PythonDomain(env) |
Python language domain. |
PythonModuleIndex(domain) |
Index subclass to provide the Python module index. |
TypedField(name[, names, typenames, label, ...]) |
A doc field that is grouped and has type information for the arguments. |
XRefRole([fix_parens, lowercase, nodeclass, ...]) |
A generic cross-referencing role. |