sphinx.ext.autodoc.DocstringStripSignatureMixin

class documentation

class DocstringStripSignatureMixin(DocstringSignatureMixin):

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 ​_find​_signature Undocumented
Method get​_doc Undocumented
Instance Variable ​_new​_docstrings Undocumented
Instance Variable ​_signatures Undocumented
Instance Variable args Undocumented
def format_signature(self, **kwargs):
overrides sphinx.ext.autodoc.DocstringSignatureMixin.format_signature

Undocumented

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

Undocumented