.. _f-sphinxmainhelper:

module ``helpgen.sphinx_main_helper``
=====================================







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

module ``pyquickhelper.helpgen.sphinx_main_helper``

Contains helpers for the main function :func:`generate_help_sphinx`.



:githublink:`%|py|7`






Functions
+++++++++

+----------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
| function                                                                                                                         | truncated documentation                                                                                                  |
+==================================================================================================================================+==========================================================================================================================+
| :func:`compile_latex_output_final <pyquickhelper.helpgen.sphinx_main_helper.compile_latex_output_final>`                         | Compiles the :epkg:`latex` documents.                                                                                    |
+----------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
| :func:`enumerate_copy_images_for_slides <pyquickhelper.helpgen.sphinx_main_helper.enumerate_copy_images_for_slides>`             | Copies images, initial intent was for slides, once converted into html, link to images are relative to the folder ...    |
+----------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
| :func:`format_history <pyquickhelper.helpgen.sphinx_main_helper.format_history>`                                                 | Formats history based on module `releases <https://github.com/bitprophet/releases>`_.                                    |
+----------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
| :func:`generate_changes_repo <pyquickhelper.helpgen.sphinx_main_helper.generate_changes_repo>`                                   | Generates a :epkg:`RST` tables containing the changes stored by a :epkg:`SVN` or :epkg:`GIT` repository, the outcome ... |
+----------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
| :func:`get_executables_path <pyquickhelper.helpgen.sphinx_main_helper.get_executables_path>`                                     | Returns the paths to :epkg:`Python`, :epkg:`Python` Scripts.                                                             |
+----------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
| :func:`my_date_conversion <pyquickhelper.helpgen.sphinx_main_helper.my_date_conversion>`                                         | Converts a date into a datetime.                                                                                         |
+----------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
| :func:`produce_code_graph_changes <pyquickhelper.helpgen.sphinx_main_helper.produce_code_graph_changes>`                         | Returns the code for a graph which counts the number of changes per week over the last year.                             |
+----------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
| :func:`replace_placeholder_by_recent_blogpost <pyquickhelper.helpgen.sphinx_main_helper.replace_placeholder_by_recent_blogpost>` | Replaces a place holder by a list of blog post.                                                                          |
+----------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
| :func:`setup_environment_for_help <pyquickhelper.helpgen.sphinx_main_helper.setup_environment_for_help>`                         | Modifies environment variables to be able to use external tools such as :epkg:`Inkscape`.                                |
+----------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+








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

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