class documentation

class TypedField(GroupedField):

Known subclasses: sphinx.domains.python.PyTypedField

View In Hierarchy

A doc field that is grouped and has type information for the arguments. It always has an argument. The argument can be linked using the given rolename, the type using the given typerolename.

Two uses are possible: either parameter and type description are given separately, using a field from names and one from typenames, respectively, or both are given using a field from names, see the example.

Example:

:param foo: description of parameter foo
:type foo:  SomeClass

-- or --

:param SomeClass foo: description of parameter foo
Method __init__ Undocumented
Method make​_field Undocumented
Class Variable is​_typed Undocumented
Instance Variable typenames Undocumented
Instance Variable typerolename Undocumented

Inherited from GroupedField:

Class Variable is​_grouped Undocumented
Instance Variable can​_collapse Undocumented

Inherited from Field (via GroupedField):

Method make​_entry Undocumented
Method make​_xref Undocumented
Method make​_xrefs Undocumented
Instance Variable bodyrolename Undocumented
Instance Variable has​_arg Undocumented
Instance Variable label Undocumented
Instance Variable name Undocumented
Instance Variable names Undocumented
Instance Variable rolename Undocumented
def __init__(self, name, names=(), typenames=(), label=None, rolename=None, typerolename=None, can_collapse=False):

Undocumented

Parameters
name:strUndocumented
names:Tuple[str, ...]Undocumented
typenames:Tuple[str, ...]Undocumented
label:strUndocumented
rolename:strUndocumented
typerolename:strUndocumented
can​_collapse:boolUndocumented
def make_field(self, types, domain, items, env=None, inliner=None, location=None):

Undocumented

Parameters
types:Dict[str, List[Node]]Undocumented
domain:strUndocumented
items:TupleUndocumented
env:BuildEnvironmentUndocumented
inliner:InlinerUndocumented
location:NodeUndocumented
Returns
nodes.fieldUndocumented
is_typed: bool =

Undocumented

typenames =

Undocumented

typerolename =

Undocumented