5.1. sphinx.domains
Support for domains, which are groupings of description directives
and roles describing e.g. constructs of one programming language.
| copyright: | Copyright 2007-2016 by the Sphinx team, see AUTHORS. |
|---|
| license: | BSD, see LICENSE for details. |
|---|
5.1.1. Functions
iteritems(d, **kw) |
Return an iterator over the (key, value) pairs of a dictionary. |
5.1.2. Classes
CDomain(env) |
C language domain. |
CPPDomain(env) |
C++ language domain. |
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. |
Index(domain) |
An Index is the description for a domain-specific index. |
JavaScriptDomain(env) |
JavaScript language domain. |
ObjType(lname, *roles, **attrs) |
An ObjType is the description for a type of object that a domain can document. |
PythonDomain(env) |
Python language domain. |
ReSTDomain(env) |
ReStructuredText domain. |
StandardDomain(env) |
Domain for all objects that don’t fit into another domain or are added via the application interface. |
5.1.3. Exceptions
SphinxError |
Base class for Sphinx errors that are shown to the user in a nicer way than normal exceptions. |