.. _f-sphinxdoctreebuilder:

module ``sphinxext.sphinx_doctree_builder``
===========================================





.. inheritance-diagram:: pyquickhelper.sphinxext.sphinx_doctree_builder


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

module ``pyquickhelper.sphinxext.sphinx_doctree_builder``

Defines a sphinx extension to output :epkg:`sphinx` doctree.


:githublink:`%|py|6`




Classes
+++++++

+-----------------------------------------------------------------------------------------------+----------------------------------+
| class                                                                                         | truncated documentation          |
+===============================================================================================+==================================+
| :class:`DocTreeBuilder <pyquickhelper.sphinxext.sphinx_doctree_builder.DocTreeBuilder>`       | Defines a doctree builder.       |
+-----------------------------------------------------------------------------------------------+----------------------------------+
| :class:`DocTreeTranslator <pyquickhelper.sphinxext.sphinx_doctree_builder.DocTreeTranslator>` | Defines a translator for doctree |
+-----------------------------------------------------------------------------------------------+----------------------------------+
| :class:`DocTreeWriter <pyquickhelper.sphinxext.sphinx_doctree_builder.DocTreeWriter>`         | Defines a doctree writer.        |
+-----------------------------------------------------------------------------------------------+----------------------------------+




Functions
+++++++++

+----------------------------------------------------------------------+----------------------------------+
| function                                                             | truncated documentation          |
+======================================================================+==================================+
| :func:`setup <pyquickhelper.sphinxext.sphinx_doctree_builder.setup>` | Initializes the doctree builder. |
+----------------------------------------------------------------------+----------------------------------+








Methods
+++++++

+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| method                                                                                                         | truncated documentation                                                                                                |
+================================================================================================================+========================================================================================================================+
| :py:meth:`__init__ <pyquickhelper.sphinxext.sphinx_doctree_builder.DocTreeBuilder.__init__>`                   | Constructor, add a logger.                                                                                             |
+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :py:meth:`__init__ <pyquickhelper.sphinxext.sphinx_doctree_builder.DocTreeTranslator.__init__>`                |                                                                                                                        |
+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :py:meth:`__init__ <pyquickhelper.sphinxext.sphinx_doctree_builder.DocTreeWriter.__init__>`                    |                                                                                                                        |
+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :py:meth:`_format_obj <pyquickhelper.sphinxext.sphinx_doctree_builder.DocTreeTranslator._format_obj>`          |                                                                                                                        |
+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :meth:`add_text <pyquickhelper.sphinxext.sphinx_doctree_builder.DocTreeTranslator.add_text>`                   |                                                                                                                        |
+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :meth:`depart_document <pyquickhelper.sphinxext.sphinx_doctree_builder.DocTreeTranslator.depart_document>`     |                                                                                                                        |
+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :meth:`depart_Text <pyquickhelper.sphinxext.sphinx_doctree_builder.DocTreeTranslator.depart_Text>`             |                                                                                                                        |
+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :meth:`end_state <pyquickhelper.sphinxext.sphinx_doctree_builder.DocTreeTranslator.end_state>`                 |                                                                                                                        |
+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :meth:`finish <pyquickhelper.sphinxext.sphinx_doctree_builder.DocTreeBuilder.finish>`                          |                                                                                                                        |
+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :meth:`get_outdated_docs <pyquickhelper.sphinxext.sphinx_doctree_builder.DocTreeBuilder.get_outdated_docs>`    | Return an iterable of input files that are outdated. This method is taken from ``TextBuilder.get_outdated_docs()`` ... |
+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :meth:`get_outfilename <pyquickhelper.sphinxext.sphinx_doctree_builder.DocTreeBuilder.get_outfilename>`        | Overwrites *get_target_uri* to control file names.                                                                     |
+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :meth:`get_target_uri <pyquickhelper.sphinxext.sphinx_doctree_builder.DocTreeBuilder.get_target_uri>`          |                                                                                                                        |
+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :meth:`handle_page <pyquickhelper.sphinxext.sphinx_doctree_builder.DocTreeBuilder.handle_page>`                |                                                                                                                        |
+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :meth:`init <pyquickhelper.sphinxext.sphinx_doctree_builder.DocTreeBuilder.init>`                              | Load necessary templates and perform initialization.                                                                   |
+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :meth:`log_unknown <pyquickhelper.sphinxext.sphinx_doctree_builder.DocTreeTranslator.log_unknown>`             |                                                                                                                        |
+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :meth:`new_state <pyquickhelper.sphinxext.sphinx_doctree_builder.DocTreeTranslator.new_state>`                 |                                                                                                                        |
+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :meth:`prepare_writing <pyquickhelper.sphinxext.sphinx_doctree_builder.DocTreeBuilder.prepare_writing>`        |                                                                                                                        |
+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :meth:`translate <pyquickhelper.sphinxext.sphinx_doctree_builder.DocTreeWriter.translate>`                     |                                                                                                                        |
+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :meth:`unknown_departure <pyquickhelper.sphinxext.sphinx_doctree_builder.DocTreeTranslator.unknown_departure>` |                                                                                                                        |
+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :meth:`unknown_visit <pyquickhelper.sphinxext.sphinx_doctree_builder.DocTreeTranslator.unknown_visit>`         |                                                                                                                        |
+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :meth:`visit_document <pyquickhelper.sphinxext.sphinx_doctree_builder.DocTreeTranslator.visit_document>`       |                                                                                                                        |
+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :meth:`visit_Text <pyquickhelper.sphinxext.sphinx_doctree_builder.DocTreeTranslator.visit_Text>`               |                                                                                                                        |
+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :meth:`wrap <pyquickhelper.sphinxext.sphinx_doctree_builder.DocTreeTranslator.wrap>`                           |                                                                                                                        |
+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :meth:`write_doc <pyquickhelper.sphinxext.sphinx_doctree_builder.DocTreeBuilder.write_doc>`                    |                                                                                                                        |
+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+


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

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