reStructuredText Docstring Processor

Docstring processor for restructured text docstring format.

Supported features:

:param <name> <?type>: <?description> directive is added to Arguments section
:type: <?description> directive transformed to Type: <type>
:returns <?type>: <?description> directive is added to Returns section
:rtype: <?description> directive transformed to Type: <type>
:raises: <?description> directive is added to Raises section
.. seealso:: directive is added to See also section
.. note:: directive is added to Notes section
.. warning:: <version> directive is added to Warnings section
.. versionadded:: <version> directive is formatted in Sphinx-style and added to Notes section
.. versionchanged:: <version> directive is formatted in Sphinx-style and added to Notes section
.. deprecated:: directive is formatted in Sphinx-style and added to Notes section
.. code-block:: directive is formatted as Markdown Python codeblock
.. code-block:: <language> directive is formatted as Markdown codeblock
.. math:: directive is formatted as Markdown Python codeblock
.. highlight:: directive is formatted as Markdown Python codeblock
.. highlight:: <language> directive is formatted as Markdown codeblock

Handsdown API Index / Handsdown / Processors / reStructuredText Docstring Processor

Auto-generated documentation for handsdown.processors.rst module.

RSTDocstringProcessor

Docstring processor for restructured text docstring format.

class RSTDocstringProcessor(BaseDocstringProcessor):
    ...