doxysphinx.utils.rst

The rst module contains rst specific helpers.

Module Contents

Functions

rst_safe_encode(→ str)

Encode text to be rst safe (special chars will get escaped correctly).

doxysphinx.utils.rst.rst_safe_encode(text: str) → str

Encode text to be rst safe (special chars will get escaped correctly).

Parameters:

text – The text to encode.

Returns:

The rst safe encoded text