sphinx.ext.autodoc.DocstringSignatureMixin

class documentation

class DocstringSignatureMixin: (source)

Known subclasses: sphinx.ext.autodoc.ClassDocumenter, sphinx.ext.autodoc.DocstringStripSignatureMixin, sphinx.ext.autodoc.FunctionDocumenter, sphinx.ext.autodoc.MethodDocumenter

View In Hierarchy

Mixin for FunctionDocumenter and MethodDocumenter to provide the feature of reading the signature from the docstring.

Method	`format_signature`	Undocumented
Method	`get_doc`	Undocumented
Instance Variable	`args`	Undocumented
Instance Variable	`retann`	Undocumented
Method	`_find_signature`	Undocumented
Instance Variable	`_new_docstrings`	Undocumented
Instance Variable	`_signatures`	Undocumented

def format_signature(self, **kwargs): (source) ¶

overridden in sphinx.ext.autodoc.ClassDocumenter, sphinx.ext.autodoc.DocstringStripSignatureMixin, sphinx.ext.autodoc.FunctionDocumenter, sphinx.ext.autodoc.MethodDocumenter

Undocumented

Parameters
**kwargs:`Any`	Undocumented
Returns
`str`	Undocumented

def get_doc(self): (source) ¶

overridden in sphinx.ext.autodoc.AttributeDocumenter, sphinx.ext.autodoc.ClassDocumenter, sphinx.ext.autodoc.MethodDocumenter

Undocumented

Returns
`list[list[str]]`	Undocumented

args = (source) ¶

Undocumented

retann = (source) ¶

overridden in sphinx.ext.autodoc.DocstringStripSignatureMixin

Undocumented

def _find_signature(self): (source) ¶

overridden in sphinx.ext.autodoc.ClassDocumenter

Undocumented

Returns
`tuple[str\|None, str\|None]`	Undocumented

_new_docstrings = (source) ¶

Undocumented

_signatures: list = (source) ¶

Undocumented