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

Entity NameDescription
OVERLOAD_HEADER_REMatches a “Overload N:” header line marking the start of one overload variant’s docs.
OVERLOAD_SEP_REMatches a lone "
RST_TYPE_REMatches a Sphinx “:type name: <type>” field-list entry.
RST_PARAM_REMatches a Sphinx “:param name: [in
RST_RTYPE_REMatches a Sphinx “:rtype: <type>” field-list entry.
RST_RETURN_REMatches a Sphinx “:return:” or “:returns:” field-list entry.
SPHINX_XREF_REMatches a Sphinx cross-reference like “:role:target” or “:domain:role:target”.
SPHINX_FIELD_HINT_RECheap signal that a docstring uses Sphinx field-list syntax (:type/:param/:rtype/:return/:raises), for dialect auto-detection.
OVERLOAD_HINT_RECheap signal that a docstring uses the “Overload N:” convention, for dialect auto-detection.

Generated with Flude

Copyright © 2026

Directory & Entity Index

Entity NameSummary / Description
OVERLOAD_HEADER_RE variable

Matches a “Overload N:” header line marking the start of one overload variant’s docs.

Instance Variables

  • ude.parsers.dialects.sphinx_rst.OVERLOAD_HEADER_RE

Generated with Flude

Copyright © 2026

OVERLOAD_HINT_RE variable

Cheap signal that a docstring uses the “Overload N:” convention, for dialect auto-detection.

Instance Variables

  • ude.parsers.dialects.sphinx_rst.OVERLOAD_HINT_RE

Generated with Flude

Copyright © 2026

OVERLOAD_SEP_RE variable

Matches a lone “|” separator line between two overload blocks.

Instance Variables

  • ude.parsers.dialects.sphinx_rst.OVERLOAD_SEP_RE

Generated with Flude

Copyright © 2026

RST_PARAM_RE variable

Matches a Sphinx “:param name: [in|out|in, out] description” field-list entry.

Instance Variables

  • ude.parsers.dialects.sphinx_rst.RST_PARAM_RE

Generated with Flude

Copyright © 2026

RST_RETURN_RE variable

Matches a Sphinx “:return:” or “:returns:” field-list entry.

Instance Variables

  • ude.parsers.dialects.sphinx_rst.RST_RETURN_RE

Generated with Flude

Copyright © 2026

RST_RTYPE_RE variable

Matches a Sphinx “:rtype: <type>” field-list entry.

Instance Variables

  • ude.parsers.dialects.sphinx_rst.RST_RTYPE_RE

Generated with Flude

Copyright © 2026

RST_TYPE_RE variable

Matches a Sphinx “:type name: <type>” field-list entry.

Instance Variables

  • ude.parsers.dialects.sphinx_rst.RST_TYPE_RE

Generated with Flude

Copyright © 2026

SPHINX_FIELD_HINT_RE variable

Cheap signal that a docstring uses Sphinx field-list syntax (:type/:param/:rtype/:return/:raises), for dialect auto-detection.

Instance Variables

  • ude.parsers.dialects.sphinx_rst.SPHINX_FIELD_HINT_RE

Generated with Flude

Copyright © 2026

SPHINX_XREF_RE variable

Matches a Sphinx cross-reference like “:role:target” or “:domain:role:target”.

Instance Variables

  • ude.parsers.dialects.sphinx_rst.SPHINX_XREF_RE

Generated with Flude

Copyright © 2026