.. _f-rstconverters:

module ``helpgen.rst_converters``
=================================







Short summary
+++++++++++++

module ``pyquickhelper.helpgen.rst_converters``

Helpers to convert docstring to various format.


:githublink:`%|py|5`






Functions
+++++++++

+----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| function                                                                                     | truncated documentation                                                                 |
+==============================================================================================+=========================================================================================+
| :func:`correct_indentation <pyquickhelper.helpgen.rst_converters.correct_indentation>`       | Tries to improve the indentation before running :epkg:`docutils`.                       |
+----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :func:`default_sphinx_options <pyquickhelper.helpgen.rst_converters.default_sphinx_options>` | Defines or overrides default options for :epkg:`Sphinx`, listed below.                  |
+----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :func:`docstring2html <pyquickhelper.helpgen.rst_converters.docstring2html>`                 | Converts a docstring into a :epkg:`HTML` format.                                        |
+----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :func:`rst2html <pyquickhelper.helpgen.rst_converters.rst2html>`                             | Converts a string from :epkg:`RST` into :epkg:`HTML` format or transformed :epkg:`RST`. |
+----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :func:`rst2rst_folder <pyquickhelper.helpgen.rst_converters.rst2rst_folder>`                 | Converts a :epkg:`RST` string into simplified :epkg:`RST`.                              |
+----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+








Documentation
+++++++++++++

.. automodule:: pyquickhelper.helpgen.rst_converters
    :members:
    :special-members: __init__
    :show-inheritance: