sphinx.domains

package documentation

Support for domains, which are groupings of description directives and roles describing e.g. constructs of one programming language.

Unknown Field: copyright
Copyright 2007-2022 by the Sphinx team, see AUTHORS.
Unknown Field: license
BSD, see LICENSE for details.
Module python sphinx.domains.python ~~~~~~~~~~~~~~~~~~~~~
Module c sphinx.domains.c ~~~~~~~~~~~~~~~~
Module changeset sphinx.domains.changeset ~~~~~~~~~~~~~~~~~~~~~~~~
Module citation sphinx.domains.citation ~~~~~~~~~~~~~~~~~~~~~~~
Module cpp sphinx.domains.cpp ~~~~~~~~~~~~~~~~~~
Module index sphinx.domains.index ~~~~~~~~~~~~~~~~~~~~
Module javascript sphinx.domains.javascript ~~~~~~~~~~~~~~~~~~~~~~~~~
Module math sphinx.domains.math ~~~~~~~~~~~~~~~~~~~
Module rst sphinx.domains.rst ~~~~~~~~~~~~~~~~~~
Module std sphinx.domains.std ~~~~~~~~~~~~~~~~~~

From __init__.py:

Class ​Domain No summary
Class ​Index An Index is the description for a domain-specific index. To add an index to a domain, subclass Index, overriding the three name attributes:
Class ​Obj​Type An ObjType is the description for a type of object that a domain can document. In the object_types attribute of Domain subclasses, object type names are mapped to instances of this class.
Class ​Index​Entry Undocumented