.. _f-sphinxmcustomapp:

module ``helpgen.sphinxm_custom_app``
=====================================





.. inheritance-diagram:: pyquickhelper.helpgen.sphinxm_custom_app


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

module ``pyquickhelper.helpgen.sphinxm_custom_app``

Inspired from module
`sphinx-testing <https://github.com/sphinx-doc/sphinx-testing/>`_


:githublink:`%|py|7`




Classes
+++++++

+-------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------+
| class                                                                               | truncated documentation                                                                    |
+=====================================================================================+============================================================================================+
| :class:`CustomSphinxApp <pyquickhelper.helpgen.sphinxm_custom_app.CustomSphinxApp>` | A subclass of class *Sphinx*, the goal is to interpret :epkg:`RST` with custom directives. |
+-------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------+










Methods
+++++++

+-------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------+
| method                                                                                                                              | truncated documentation                                   |
+=====================================================================================================================================+===========================================================+
| :py:meth:`__init__ <pyquickhelper.helpgen.sphinxm_custom_app.CustomSphinxApp.__init__>`                                             |                                                           |
+-------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------+
| :py:meth:`__str__ <pyquickhelper.helpgen.sphinxm_custom_app.CustomSphinxApp.__str__>`                                               | usual                                                     |
+-------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------+
| :py:meth:`_add_missing_element_in_config <pyquickhelper.helpgen.sphinxm_custom_app.CustomSphinxApp._add_missing_element_in_config>` | Adds extra elements in config such as ``latex_elements``. |
+-------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------+
| :meth:`cleanup <pyquickhelper.helpgen.sphinxm_custom_app.CustomSphinxApp.cleanup>`                                                  | do some cleanup                                           |
+-------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------+


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

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