List of classes in the ude.parsers.dialects.sphinx_rst namespace.
Sphinx/RST field-list docstring dialect.
Parses Python SWIG-generated docstrings that use Sphinx-style field lists
(:param:, :type:, :rtype:, :return:) and the
*Overload N:* multi-overload convention, as emitted for BimNv-style
Python bindings.
| Entity Name | Description |
|---|---|
| SphinxRstSwigDialect | Handles Python SWIG-generated docstrings that use the Sphinx/RST field list style. |
| _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. |
| OVERLOAD_HEADER_RE | Matches a “Overload N:” header line marking the start of one overload variant’s docs. |
| OVERLOAD_SEP_RE | Matches a lone " |
| RST_TYPE_RE | Matches a Sphinx “:type name: <type>” field-list entry. |
| RST_PARAM_RE | Matches a Sphinx “:param name: [in |
| RST_RTYPE_RE | Matches a Sphinx “:rtype: <type>” field-list entry. |
| RST_RETURN_RE | Matches a Sphinx “:return:” or “:returns:” field-list entry. |
| SPHINX_XREF_RE | Matches a Sphinx cross-reference like “:role:target” or “:domain:role:target”. |
| SPHINX_FIELD_HINT_RE | Cheap signal that a docstring uses Sphinx field-list syntax (:type/:param/:rtype/:return/:raises), for dialect auto-detection. |
| OVERLOAD_HINT_RE | Cheap signal that a docstring uses the “Overload N:” convention, for dialect auto-detection. |