class TypedField(GroupedField): (source)
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 |
Undocumented |
Class Variable | is |
Undocumented |
Instance Variable | typenames |
Undocumented |
Instance Variable | typerolename |
Undocumented |
Inherited from GroupedField
:
Class Variable | is |
Undocumented |
Instance Variable | can |
Undocumented |
Inherited from Field
(via GroupedField
):
Method | make |
Undocumented |
Method | make |
Undocumented |
Method | make |
Undocumented |
Instance Variable | bodyrolename |
Undocumented |
Instance Variable | has |
Undocumented |
Instance Variable | label |
Undocumented |
Instance Variable | name |
Undocumented |
Instance Variable | names |
Undocumented |
Instance Variable | rolename |
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 |