Cmdoption(name, arguments, options, content, ...) |
Description of a command-line option (.. |
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. |
EnvVar(name, arguments, options, content, ...) |
|
EnvVarXRefRole([fix_parens, lowercase, ...]) |
Cross-referencing role for environment variables (adds an index entry). |
GenericObject(name, arguments, options, ...) |
A generic x-ref directive registered with Sphinx.add_object_type(). |
Glossary(name, arguments, options, content, ...) |
Directive to create a glossary with cross-reference targets for :term: roles. |
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. |
OptionXRefRole([fix_parens, lowercase, ...]) |
|
ProductionList(name, arguments, options, ...) |
Directive to list grammar productions. |
Program(name, arguments, options, content, ...) |
Directive to name the program for which options are documented. |
StandardDomain(env) |
Domain for all objects that don’t fit into another domain or are added via the application interface. |
Target(name, arguments, options, content, ...) |
Generic target for user-defined cross-reference types. |
ViewList([initlist, source, items, parent, ...]) |
List with extended functionality: slices of ViewList objects are child lists, linked to their parents. |
XRefRole([fix_parens, lowercase, nodeclass, ...]) |
A generic cross-referencing role. |