sphinx.ext.autodoc.DocstringStripSignatureMixin

class documentation

class DocstringStripSignatureMixin(DocstringSignatureMixin): (source)

Known subclasses: sphinx.ext.autodoc.AttributeDocumenter, sphinx.ext.autodoc.PropertyDocumenter

View In Hierarchy

Mixin for AttributeDocumenter to provide the feature of stripping any function signature from the docstring.

Method format_signature Undocumented
Instance Variable retann Undocumented

Inherited from DocstringSignatureMixin:

Method get_doc Undocumented
Instance Variable args Undocumented
Method _find_signature Undocumented
Instance Variable _new_docstrings Undocumented
Instance Variable _signatures Undocumented
def format_signature(self, **kwargs): (source)
overrides sphinx.ext.autodoc.DocstringSignatureMixin.format_signature

Undocumented

Parameters
**kwargs:AnyUndocumented
Returns
strUndocumented
retann = (source)
overrides sphinx.ext.autodoc.DocstringSignatureMixin.retann

Undocumented