sphinx.ext.napoleon.docstring

module documentation
(source)

Classes for docstring parsing and formatting.

Class Deque A subclass of deque that mimics ``pockets.iterators.modify_iter``.
Class GoogleDocstring Convert Google style docstrings to reStructuredText.
Class NumpyDocstring Convert NumPy style docstrings to reStructuredText.
Variable logger Undocumented
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 = (source)

Undocumented

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

Undocumented

Parameters
_type:strUndocumented
location:str|NoneUndocumented
translations:dictUndocumented
Returns
strUndocumented
def _convert_type_spec(_type, translations={}): (source)

Convert type specification to reference in reST.

Parameters
_type:strUndocumented
translations:dict[str, str]Undocumented
Returns
strUndocumented
def _recombine_set_tokens(tokens): (source)

Undocumented

Parameters
tokens:list[str]Undocumented
Returns
list[str]Undocumented
def _token_type(token, location=None): (source)

Undocumented

Parameters
token:strUndocumented
location:str|NoneUndocumented
Returns
strUndocumented
def _tokenize_type_spec(spec): (source)

Undocumented

Parameters
spec:strUndocumented
Returns
list[str]Undocumented
_SINGLETONS: tuple[str, ...] = (source)

Undocumented

Value
('None', 'True', 'False', 'Ellipsis')
_bullet_list_regex = (source)

Undocumented

_default_regex = (source)

Undocumented

_directive_regex = (source)

Undocumented

_enumerated_list_regex = (source)

Undocumented

_google_section_regex = (source)

Undocumented

_google_typed_arg_regex = (source)

Undocumented

_numpy_section_regex = (source)

Undocumented

_single_colon_regex = (source)

Undocumented

_token_regex = (source)

Undocumented

_xref_or_code_regex = (source)

Undocumented

_xref_regex = (source)

Undocumented