.. _f-sphinxcommonbuilder:

module ``sphinxext._sphinx_common_builder``
===========================================





.. inheritance-diagram:: pyquickhelper.sphinxext._sphinx_common_builder


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

module ``pyquickhelper.sphinxext._sphinx_common_builder``

Common functions for :epkg:`Sphinx` writers.


:githublink:`%|py|6`




Classes
+++++++

+---------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------+
| class                                                                                                         | truncated documentation                                                    |
+===============================================================================================================+============================================================================+
| :class:`CommonSphinxWriterHelpers <pyquickhelper.sphinxext._sphinx_common_builder.CommonSphinxWriterHelpers>` | Common functions used in :class:`RstTranslator` and :class:`MdTranslator`. |
+---------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------+










Methods
+++++++

+------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| method                                                                                                                 | truncated documentation                                                                                                                                                                              |
+========================================================================================================================+======================================================================================================================================================================================================+
| :meth:`base_visit_image <pyquickhelper.sphinxext._sphinx_common_builder.CommonSphinxWriterHelpers.base_visit_image>`   | Processes an image. By default, it writes the image on disk. Inspired from `visit_image <https://github.com/docutils-mirror/docutils/blob/master/docutils/writers/html4css1/__init__.py#L1019>`_ ... |
+------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :meth:`hash_md5_readfile <pyquickhelper.sphinxext._sphinx_common_builder.CommonSphinxWriterHelpers.hash_md5_readfile>` | Computes a hash of a file.                                                                                                                                                                           |
+------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+


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

.. automodule:: pyquickhelper.sphinxext._sphinx_common_builder
    :members:
    :special-members: __init__
    :show-inheritance: