class TypedField(GroupedField):
Known subclasses: sphinx.domains.python.PyTypedField
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 |
Undocumented
Parameters | |
name:str | Undocumented |
names:Tuple[ | Undocumented |
typenames:Tuple[ | Undocumented |
label:str | Undocumented |
rolename:str | Undocumented |
typerolename:str | Undocumented |
can_collapse:bool | Undocumented |
Undocumented
Parameters | |
types:Dict[ | Undocumented |
domain:str | Undocumented |
items:Tuple | Undocumented |
env:BuildEnvironment | Undocumented |
inliner:Inliner | Undocumented |
location:Node | Undocumented |
Returns | |
nodes.field | Undocumented |