sphinx.domains.python

module documentation

The Python domain.

Unknown Field: copyright
Copyright 2007-2022 by the Sphinx team, see AUTHORS.
Unknown Field: license
BSD, see LICENSE for details.
Class ​Python​Domain Python language domain.
Variable logger Undocumented
Variable pairindextypes Undocumented
Variable py​_sig​_re Undocumented
Class ​Module​Entry Undocumented
Class ​Object​Entry Undocumented
Class ​Py​Attribute Description of an attribute.
Class ​Py​Classlike Description of a class-like object (classes, interfaces, exceptions).
Class ​Py​Class​Method Description of a classmethod.
Class ​Py​Current​Module 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 ​Py​Decorator​Function Description of a decorator.
Class ​Py​Decorator​Method Description of a decoratormethod.
Class ​Py​Decorator​Mixin Mixin for decorator directives.
Class ​Py​Field Undocumented
Class ​Py​Function Description of a function.
Class ​Py​Grouped​Field Undocumented
Class ​Py​Method Description of a method.
Class ​Py​Module Directive to mark description of a new module.
Class ​Py​Object Description of a general Python object.
Class ​Py​Property Description of an attribute.
Class ​Py​Static​Method Description of a staticmethod.
Class ​Python​Module​Index Index subclass to provide the Python module index.
Class ​Py​Typed​Field Undocumented
Class ​Py​Variable Description of a variable.
Class ​Py​Xref​Mixin Undocumented
Class ​Py​XRef​Role 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.
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.
logger =

Undocumented

pairindextypes =

Undocumented

py_sig_re =

Undocumented

def _parse_annotation(annotation, env=None):
Parse type annotation.
Parameters
annotation:strUndocumented
env:BuildEnvironmentUndocumented
Returns
List[Node]Undocumented
def _parse_arglist(arglist, env=None):
Parse a list of arguments using AST parser
Parameters
arglist:strUndocumented
env:BuildEnvironmentUndocumented
Returns
addnodes.desc_parameterlistUndocumented
def _pseudo_parse_arglist(signode, arglist):

"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_signatureUndocumented
arglist:strUndocumented
def builtin_resolver(app, env, node, contnode):
Do not emit nitpicky warnings for built-in types.
Parameters
app:SphinxUndocumented
env:BuildEnvironmentUndocumented
node:pending_xrefUndocumented
contnode:ElementUndocumented
Returns
ElementUndocumented
def filter_meta_fields(app, domain, objtype, content):
Filter :meta: field from its docstring.
Parameters
app:SphinxUndocumented
domain:strUndocumented
objtype:strUndocumented
content:ElementUndocumented
def parse_reftarget(reftarget, suppress_prefix=False):
Parse a type string and return (reftype, reftarget, title, refspecific flag)
Parameters
reftarget:strUndocumented
suppress​_prefix:boolUndocumented
Returns
Tuple[str, str, str, bool]Undocumented
def setup(app):

Undocumented

Parameters
app:SphinxUndocumented
Returns
Dict[str, Any]Undocumented
def type_to_xref(target, env=None, suppress_prefix=False):
Convert a type string to a cross reference node.
Parameters
target:strUndocumented
env:BuildEnvironmentUndocumented
suppress​_prefix:boolUndocumented
Returns
addnodes.pending_xrefUndocumented