.. _f-sphinxmain:

module ``helpgen.sphinx_main``
==============================







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

module ``pyquickhelper.helpgen.sphinx_main``

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:`_check_sphinx_configuration <pyquickhelper.helpgen.sphinx_main._check_sphinx_configuration>`       | Operates some verification on the configuration.                                                          |
+-----------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+
| :func:`_import_conf_extract_parameter <pyquickhelper.helpgen.sphinx_main._import_conf_extract_parameter>` | Imports the configuration file and extracts some of the parameters it defines. Fills the following lists. |
+-----------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+
| :func:`_process_sphinx_in_private_cmd <pyquickhelper.helpgen.sphinx_main._process_sphinx_in_private_cmd>` |                                                                                                           |
+-----------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+
| :func:`generate_help_sphinx <pyquickhelper.helpgen.sphinx_main.generate_help_sphinx>`                     | Runs the help generation:                                                                                 |
+-----------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+








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

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