Functions

List of functions in the ude.parsers.dialects.sphinx_rst namespace.

Entity Name	Description
_clean_xrefs	Replaces :domain:role:`target` with bare target text.
_strip_rst_fields	Removes :type:, :param:, :rtype:, :return:, :raises: field-list entries (including continuations). docstring text to strip field-list entries from.
_extract_params_from_chunk	Parse :type:/:param: fields from a docstring chunk.

Generated with Flude

Directory & Entity Index

Entity Name Summary / Description

Replaces :domain:role:target with bare target text.

Returns:

The text with cross-reference markup removed.

_clean_xrefs(text: str) -> str

Replaces :domain:role:target with bare target text.

Returns:

The text with cross-reference markup removed.

Parameter	Type	Description
text	`str`	The text to clean.

Generated with Flude

Parse :type:/:param: fields from a docstring chunk.

Returns (params, param_types, arg_order). docstring segment (a whole docstring, or one overload’s slice).

Returns:

A tuple of (parameter name to description, parameter name to type,

_extract_params_from_chunk(chunk: A) -> Tuple[Dict[str, str], Dict[str, str], List[str]]

Parse :type:/:param: fields from a docstring chunk.

Returns (params, param_types, arg_order). docstring segment (a whole docstring, or one overload’s slice).

Returns:

A tuple of (parameter name to description, parameter name to type,

Removes :type:, :param:, :rtype:, :return:, :raises: field-list entries (including continuations). docstring text to strip field-list entries from.

Returns:

The text with all recognized field-list entries removed.

_strip_rst_fields(text: The) -> str

Removes :type:, :param:, :rtype:, :return:, :raises: field-list entries (including continuations). docstring text to strip field-list entries from.

Returns:

The text with all recognized field-list entries removed.

Parameter	Type	Description
text	`The`

Generated with Flude