sphinx.ext.autodoc.preserve_defaults

module documentation

Preserve the default argument values of function signatures in source code and keep them not evaluated for readability.

Unknown Field: copyright
Copyright 2007-2022 by the Sphinx team, see AUTHORS.
Unknown Field: license
BSD, see LICENSE for details.
Variable logger Undocumented
Class ​Default​Value Undocumented
Function get​_default​_value Undocumented
Function get​_function​_def Get FunctionDef object from living object. This tries to parse original code for living object and returns AST node for given obj.
Function setup Undocumented
Function update​_defvalue Update defvalue info of obj using type_comments.
logger =

Undocumented

def get_default_value(lines, position):

Undocumented

Parameters
lines:List[str]Undocumented
position:ast.ASTUndocumented
Returns
Optional[str]Undocumented
def get_function_def(obj):
Get FunctionDef object from living object. This tries to parse original code for living object and returns AST node for given obj.
Parameters
obj:AnyUndocumented
Returns
ast.FunctionDefUndocumented
def setup(app):

Undocumented

Parameters
app:SphinxUndocumented
Returns
Dict[str, Any]Undocumented
def update_defvalue(app, obj, bound_method):
Update defvalue info of obj using type_comments.
Parameters
app:SphinxUndocumented
obj:AnyUndocumented
bound​_method:boolUndocumented