sphinx.domains.python.PyXrefMixin

class documentation

class PyXrefMixin: (source)

Known subclasses: sphinx.domains.python.PyField, sphinx.domains.python.PyGroupedField, sphinx.domains.python.PyTypedField

View In Hierarchy

Undocumented

Method make_xref Undocumented
Method make_xrefs Undocumented
def make_xref(self, rolename, domain, target, innernode=nodes.emphasis, contnode=None, env=None, inliner=None, location=None): (source)

Undocumented

Parameters
rolename:strUndocumented
domain:strUndocumented
target:strUndocumented
innernode:type[TextlikeNode]Undocumented
contnode:Node|NoneUndocumented
env:BuildEnvironment|NoneUndocumented
inliner:Inliner|NoneUndocumented
location:Node|NoneUndocumented
Returns
NodeUndocumented
def make_xrefs(self, rolename, domain, target, innernode=nodes.emphasis, contnode=None, env=None, inliner=None, location=None): (source)

Undocumented

Parameters
rolename:strUndocumented
domain:strUndocumented
target:strUndocumented
innernode:type[TextlikeNode]Undocumented
contnode:Node|NoneUndocumented
env:BuildEnvironment|NoneUndocumented
inliner:Inliner|NoneUndocumented
location:Node|NoneUndocumented
Returns
list[Node]Undocumented