sphinx.ext.napoleon.docstring

module documentation

Classes for docstring parsing and formatting.

Unknown Field: copyright
Copyright 2007-2022 by the Sphinx team, see AUTHORS.
Unknown Field: license
BSD, see LICENSE for details.

Variable	`logger`	Undocumented
Class	`GoogleDocstring`	Convert Google style docstrings to reStructuredText.
Class	`NumpyDocstring`	Convert NumPy style docstrings to reStructuredText.
Function	`_convert_numpy_type_spec`	Undocumented
Function	`_convert_type_spec`	Convert type specification to reference in reST.
Function	`_recombine_set_tokens`	Undocumented
Function	`_token_type`	Undocumented
Function	`_tokenize_type_spec`	Undocumented
Constant	`_SINGLETONS`	Undocumented
Variable	`_bullet_list_regex`	Undocumented
Variable	`_default_regex`	Undocumented
Variable	`_directive_regex`	Undocumented
Variable	`_enumerated_list_regex`	Undocumented
Variable	`_google_section_regex`	Undocumented
Variable	`_google_typed_arg_regex`	Undocumented
Variable	`_numpy_section_regex`	Undocumented
Variable	`_single_colon_regex`	Undocumented
Variable	`_token_regex`	Undocumented
Variable	`_xref_or_code_regex`	Undocumented
Variable	`_xref_regex`	Undocumented

logger =

Undocumented

def _convert_numpy_type_spec(_type, location=None, translations={}):

Undocumented

def _convert_type_spec(_type, translations={}):

Convert type specification to reference in reST.

def _recombine_set_tokens(tokens):

Undocumented

def _token_type(token, location=None):

Undocumented

def _tokenize_type_spec(spec):

Undocumented

_SINGLETONS: tuple[str, ...] =

Undocumented

Value

('None', 'True', 'False', 'Ellipsis')

_bullet_list_regex =

Undocumented

_default_regex =

Undocumented

_directive_regex =

Undocumented

_enumerated_list_regex =

Undocumented

_google_section_regex =

Undocumented

_google_typed_arg_regex =

Undocumented

_numpy_section_regex =

Undocumented

_single_colon_regex =

Undocumented

_token_regex =

Undocumented

_xref_or_code_regex =

Undocumented

_xref_regex =

Undocumented