.. _f-sphinxmainverification:

module ``helpgen.sphinx_main_verification``
===========================================





.. inheritance-diagram:: pyquickhelper.helpgen.sphinx_main_verification


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

module ``pyquickhelper.helpgen.sphinx_main_verification``

Function to verify the files produced by Sphinx


:githublink:`%|py|6`




Classes
+++++++

+-------------------------------------------------------------------------------------------------------------------+-----------------------------+
| class                                                                                                             | truncated documentation     |
+===================================================================================================================+=============================+
| :class:`SphinxVerificationException <pyquickhelper.helpgen.sphinx_main_verification.SphinxVerificationException>` | to format the error message |
+-------------------------------------------------------------------------------------------------------------------+-----------------------------+




Functions
+++++++++

+------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+
| function                                                                                                   | truncated documentation                                                                                             |
+============================================================================================================+=====================================================================================================================+
| :func:`verification_html_file <pyquickhelper.helpgen.sphinx_main_verification.verification_html_file>`     | Verifies a file produced by :epkg:`sphinx` and checks basic mistakes.                                               |
+------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+
| :func:`verification_html_format <pyquickhelper.helpgen.sphinx_main_verification.verification_html_format>` | dig into folders abd subfolders to find HTML files produced by Sphinx, does some verification to detect errors, ... |
+------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+








Methods
+++++++

+-----------------------------------------------------------------------------------------------------------+-------------------------+
| method                                                                                                    | truncated documentation |
+===========================================================================================================+=========================+
| :py:meth:`__init__ <pyquickhelper.helpgen.sphinx_main_verification.SphinxVerificationException.__init__>` |                         |
+-----------------------------------------------------------------------------------------------------------+-------------------------+


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

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