sphinx.ext.autodoc.DocstringSignatureMixin

class documentation

class DocstringSignatureMixin:

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 ​_find​_signature Undocumented
Method format​_signature Undocumented
Method get​_doc Undocumented
Instance Variable ​_new​_docstrings Undocumented
Instance Variable ​_signatures Undocumented
Instance Variable args Undocumented
Instance Variable retann Undocumented
def _find_signature(self):

Undocumented

Returns
Tuple[str, str]Undocumented
def format_signature(self, **kwargs):
overridden in sphinx.ext.autodoc.ClassDocumenter, sphinx.ext.autodoc.DocstringStripSignatureMixin, sphinx.ext.autodoc.FunctionDocumenter, sphinx.ext.autodoc.MethodDocumenter

Undocumented

Parameters
**kwargs:AnyUndocumented
Returns
strUndocumented
def get_doc(self, ignore=None):
overridden in sphinx.ext.autodoc.AttributeDocumenter, sphinx.ext.autodoc.ClassDocumenter, sphinx.ext.autodoc.MethodDocumenter

Undocumented

Parameters
ignore:intUndocumented
Returns
List[List[str]]Undocumented
_new_docstrings =

Undocumented

_signatures: list =

Undocumented

args =

Undocumented

retann =
overridden in sphinx.ext.autodoc.DocstringStripSignatureMixin

Undocumented