sphinx.ext.autodoc.typehints

module documentation

Generating content for autodoc using typehints

Unknown Field: copyright
Copyright 2007-2022 by the Sphinx team, see AUTHORS.
Unknown Field: license
BSD, see LICENSE for details.
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):

Undocumented

Parameters
node:nodes.field_listUndocumented
annotations:Dict[str, str]Undocumented
def insert_field_list(node):

Undocumented

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

Undocumented

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

Undocumented

Parameters
node:nodes.field_listUndocumented
annotations:Dict[str, str]Undocumented
def record_typehints(app, objtype, name, obj, options, args, retann):
Record type hints to env object.
Parameters
app:SphinxUndocumented
objtype:strUndocumented
name:strUndocumented
obj:AnyUndocumented
options:DictUndocumented
args:strUndocumented
retann:strUndocumented
def setup(app):

Undocumented

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