sphinx.ext.autodoc.typehints

module documentation
(source)

Generating content for autodoc using typehints

Function augment_descriptions_with_types Undocumented
Function insert_field_list Undocumented
Function merge_typehints Undocumented
Function modify_field_list Undocumented
Function record_typehints Record type hints to env object.
Function setup Undocumented
def augment_descriptions_with_types(node, annotations, force_rtype): (source)

Undocumented

Parameters
node:nodes.field_listUndocumented
annotations:dict[str, str]Undocumented
force_rtype:boolUndocumented
def insert_field_list(node): (source)

Undocumented

Parameters
node:ElementUndocumented
Returns
nodes.field_listUndocumented
def merge_typehints(app, domain, objtype, contentnode): (source)

Undocumented

Parameters
app:SphinxUndocumented
domain:strUndocumented
objtype:strUndocumented
contentnode:ElementUndocumented
def modify_field_list(node, annotations, suppress_rtype=False): (source)

Undocumented

Parameters
node:nodes.field_listUndocumented
annotations:dict[str, str]Undocumented
suppress_rtype:boolUndocumented
def record_typehints(app, objtype, name, obj, options, args, retann): (source)

Record type hints to env object.

Parameters
app:SphinxUndocumented
objtype:strUndocumented
name:strUndocumented
obj:AnyUndocumented
options:dictUndocumented
args:strUndocumented
retann:strUndocumented
def setup(app): (source)

Undocumented

Parameters
app:SphinxUndocumented
Returns
dict[str, Any]Undocumented