.. _f-utilssphinxconfig:

module ``helpgen.utils_sphinx_config``
======================================







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

module ``pyquickhelper.helpgen.utils_sphinx_config``

Check various settings.


:githublink:`%|py|5`






Functions
+++++++++

+-----------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+
| function                                                                                                  | truncated documentation                                                                       |
+===========================================================================================================+===============================================================================================+
| :func:`_NbImage <pyquickhelper.helpgen.utils_sphinx_config._NbImage>`                                     |                                                                                               |
+-----------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+
| :func:`_NbImage_path <pyquickhelper.helpgen.utils_sphinx_config._NbImage_path>`                           |                                                                                               |
+-----------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+
| :func:`getsitepackages <pyquickhelper.helpgen.utils_sphinx_config.getsitepackages>`                       | Overwrites function :epkg:`getsitepackages` which does not work for a virtual environment.    |
+-----------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+
| :func:`locate_image_documentation <pyquickhelper.helpgen.utils_sphinx_config.locate_image_documentation>` | Tries to local an image in the module for help generation in a folder ``_doc``.               |
+-----------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+
| :func:`NbImage <pyquickhelper.helpgen.utils_sphinx_config.NbImage>`                                       | Retrieves a name or a url of the image if it is not found in the local folder or a subfolder. |
+-----------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+








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

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