sphinx.domains.python

module documentation

(source)

The Python domain.

Class	`ModuleEntry`	Undocumented
Class	`ObjectEntry`	Undocumented
Class	`PyAttribute`	Description of an attribute.
Class	`PyClasslike`	Description of a class-like object (classes, interfaces, exceptions).
Class	`PyClassMethod`	Description of a classmethod.
Class	`PyCurrentModule`	This directive is just to tell Sphinx that we're documenting stuff in module foo, but links to module foo won't lead here.
Class	`PyDecoratorFunction`	Description of a decorator.
Class	`PyDecoratorMethod`	Description of a decoratormethod.
Class	`PyField`	Undocumented
Class	`PyFunction`	Description of a function.
Class	`PyGroupedField`	Undocumented
Class	`PyMethod`	Description of a method.
Class	`PyModule`	Directive to mark description of a new module.
Class	`PyObject`	Description of a general Python object.
Class	`PyProperty`	Description of an attribute.
Class	`PyStaticMethod`	Description of a staticmethod.
Class	`PythonDomain`	Python language domain.
Class	`PythonModuleIndex`	Index subclass to provide the Python module index.
Class	`PyTypedField`	Undocumented
Class	`PyVariable`	Description of a variable.
Class	`PyXrefMixin`	Undocumented
Class	`PyXRefRole`	Undocumented
Function	`builtin_resolver`	Do not emit nitpicky warnings for built-in types.
Function	`filter_meta_fields`	Filter ``:meta:`` field from its docstring.
Function	`parse_reftarget`	Parse a type string and return (reftype, reftarget, title, refspecific flag)
Function	`setup`	Undocumented
Function	`type_to_xref`	Convert a type string to a cross reference node.
Variable	`logger`	Undocumented
Variable	`pairindextypes`	Undocumented
Variable	`py_sig_re`	Undocumented
Function	`_parse_annotation`	Parse type annotation.
Function	`_parse_arglist`	Parse a list of arguments using AST parser
Function	`_pseudo_parse_arglist`	"Parse" a list of arguments separated by commas.

def builtin_resolver(app, env, node, contnode): (source) ¶

Do not emit nitpicky warnings for built-in types.

Parameters
app:`Sphinx`	Undocumented
env:`BuildEnvironment`	Undocumented
node:`pending_xref`	Undocumented
contnode:`Element`	Undocumented
Returns
`Element\|None`	Undocumented

def filter_meta_fields(app, domain, objtype, content): (source) ¶

Filter ``:meta:`` field from its docstring.

Parameters
app:`Sphinx`	Undocumented
domain:`str`	Undocumented
objtype:`str`	Undocumented
content:`Element`	Undocumented

def parse_reftarget(reftarget, suppress_prefix=False): (source) ¶

Parse a type string and return (reftype, reftarget, title, refspecific flag)

Parameters
reftarget:`str`	Undocumented
suppress_prefix:`bool`	Undocumented
Returns
`tuple[str, str, str, bool]`	Undocumented

def setup(app): (source) ¶

Undocumented

Parameters
app:`Sphinx`	Undocumented
Returns
`dict[str, Any]`	Undocumented

def type_to_xref(target, env=None, suppress_prefix=False): (source) ¶

Convert a type string to a cross reference node.

Parameters
target:`str`	Undocumented
env:`BuildEnvironment\|None`	Undocumented
suppress_prefix:`bool`	Undocumented
Returns
`addnodes.pending_xref`	Undocumented

logger = (source) ¶

Undocumented

pairindextypes = (source) ¶

Undocumented

py_sig_re = (source) ¶

Undocumented

def _parse_annotation(annotation, env): (source) ¶

Parse type annotation.

Parameters
annotation:`str`	Undocumented
env:`BuildEnvironment\|None`	Undocumented
Returns
`list[Node]`	Undocumented

def _parse_arglist(arglist, env=None): (source) ¶

Parse a list of arguments using AST parser

Parameters
arglist:`str`	Undocumented
env:`BuildEnvironment\|None`	Undocumented
Returns
`addnodes.desc_parameterlist`	Undocumented

def _pseudo_parse_arglist(signode, arglist): (source) ¶

"Parse" a list of arguments separated by commas. Arguments can have "optional" annotations given by enclosing them in brackets. Currently, this will split at any comma, even if it's inside a string literal (e.g. default argument value).

Parameters
signode:`desc_signature`	Undocumented
arglist:`str`	Undocumented