.. _f-postprocess:

module ``helpgen.post_process``
===============================







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

module ``pyquickhelper.helpgen.post_process``

Contains the main function to generate the documentation
for a module designed the same way as this one, :func:`generate_help_sphinx`.


:githublink:`%|py|7`






Functions
+++++++++

+----------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
| function                                                                                                 | truncated documentation                                                                                           |
+==========================================================================================================+===================================================================================================================+
| :func:`_notebook_replacements <pyquickhelper.helpgen.post_process._notebook_replacements>`               | Makes some replacements in a notebook.                                                                            |
+----------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
| :func:`post_process_html_output <pyquickhelper.helpgen.post_process.post_process_html_output>`           | Processes a HTML file generated from the conversion of a notebook.                                                |
+----------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
| :func:`post_process_latex <pyquickhelper.helpgen.post_process.post_process_latex>`                       | Modifies a :epkg:`latex` file after its generation by :epkg:`sphinx`.                                             |
+----------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
| :func:`post_process_latex_output <pyquickhelper.helpgen.post_process.post_process_latex_output>`         | Postprocesses the latex file produced by :epkg:`sphinx`.                                                          |
+----------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
| :func:`post_process_latex_output_any <pyquickhelper.helpgen.post_process.post_process_latex_output_any>` | Postprocesses the latex file produced by :epkg:`sphinx`.                                                          |
+----------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
| :func:`post_process_python <pyquickhelper.helpgen.post_process.post_process_python>`                     | Modifies a python file after its generation by :epkg:`sphinx`.                                                    |
+----------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
| :func:`post_process_python_output <pyquickhelper.helpgen.post_process.post_process_python_output>`       | Postprocesses the python file produced by :epkg:`sphinx`.                                                         |
+----------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
| :func:`post_process_rst_output <pyquickhelper.helpgen.post_process.post_process_rst_output>`             | Processes a :epkg:`rst` file generated from the conversion of a notebook.                                         |
+----------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
| :func:`post_process_slides_output <pyquickhelper.helpgen.post_process.post_process_slides_output>`       | Processes a :epkg:`HTML` file generated from the conversion of a notebook.                                        |
+----------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
| :func:`remove_character_under32 <pyquickhelper.helpgen.post_process.remove_character_under32>`           | Removes :epkg:`ASCII` characters in *[0..31]*.                                                                    |
+----------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
| :func:`update_notebook_link <pyquickhelper.helpgen.post_process.update_notebook_link>`                   | A notebook can contain a link ``[anchor](find://...)`` and it will be converted into: ``:ref:...`` in rst format. |
+----------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+








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

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