sphinx.domains.rst
The reStructuredText domain.
| copyright: | Copyright 2007-2016 by the Sphinx team, see AUTHORS. |
|---|
| license: | BSD, see LICENSE for details. |
|---|
Functions
iteritems(d, **kw) |
Return an iterator over the (key, value) pairs of a dictionary. |
l_(string) |
A lazy version of gettext. |
make_refnode(builder, fromdocname, ...[, title]) |
Shortcut to create a reference node. |
parse_directive(d) |
Parse a directive signature. |
Classes
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. |
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. |
ReSTDirective(name, arguments, options, ...) |
Description of a reST directive. |
ReSTDomain(env) |
ReStructuredText domain. |
ReSTMarkup(name, arguments, options, ...) |
Description of generic reST markup. |
ReSTRole(name, arguments, options, content, ...) |
Description of a reST role. |
XRefRole([fix_parens, lowercase, nodeclass, ...]) |
A generic cross-referencing role. |