.. _f-singlefilehtmlbuilder:

module ``helpgen._single_file_html_builder``
============================================





.. inheritance-diagram:: pyquickhelper.helpgen._single_file_html_builder


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

module ``pyquickhelper.helpgen._single_file_html_builder``

Copy of `singlehtml.py <https://github.com/sphinx-doc/sphinx/blob/3.x/sphinx/builders/singlehtml.py>`_

Single HTML builders.

:copyright: Copyright 2007-2020 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.


:githublink:`%|py|10`




Classes
+++++++

+--------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------+
| class                                                                                                              | truncated documentation                                                              |
+====================================================================================================================+======================================================================================+
| :class:`CustomSingleFileHTMLBuilder <pyquickhelper.helpgen._single_file_html_builder.CustomSingleFileHTMLBuilder>` | A StandaloneHTMLBuilder subclass that puts the whole document tree on one HTML page. |
+--------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------+






Properties
++++++++++

+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------+
| property                                                                                                                                | truncated documentation |
+=========================================================================================================================================+=========================+
| :meth:`default_translator_class <pyquickhelper.helpgen._single_file_html_builder.CustomSingleFileHTMLBuilder.default_translator_class>` |                         |
+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------+
| :meth:`math_renderer_name <pyquickhelper.helpgen._single_file_html_builder.CustomSingleFileHTMLBuilder.math_renderer_name>`             |                         |
+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------+




Static Methods
++++++++++++++

+-------------------------------------------------------------------------------------------------------------------------------------+-------------------------+
| staticmethod                                                                                                                        | truncated documentation |
+=====================================================================================================================================+=========================+
| :meth:`write_additional_files <pyquickhelper.helpgen._single_file_html_builder.CustomSingleFileHTMLBuilder.write_additional_files>` |                         |
+-------------------------------------------------------------------------------------------------------------------------------------+-------------------------+




Methods
+++++++

+---------------------------------------------------------------------------------------------------------------------------------------+-------------------------+
| method                                                                                                                                | truncated documentation |
+=======================================================================================================================================+=========================+
| :py:meth:`_get_local_toctree <pyquickhelper.helpgen._single_file_html_builder.CustomSingleFileHTMLBuilder._get_local_toctree>`        |                         |
+---------------------------------------------------------------------------------------------------------------------------------------+-------------------------+
| :meth:`assemble_doctree <pyquickhelper.helpgen._single_file_html_builder.CustomSingleFileHTMLBuilder.assemble_doctree>`               |                         |
+---------------------------------------------------------------------------------------------------------------------------------------+-------------------------+
| :meth:`assemble_toc_fignumbers <pyquickhelper.helpgen._single_file_html_builder.CustomSingleFileHTMLBuilder.assemble_toc_fignumbers>` |                         |
+---------------------------------------------------------------------------------------------------------------------------------------+-------------------------+
| :meth:`assemble_toc_secnumbers <pyquickhelper.helpgen._single_file_html_builder.CustomSingleFileHTMLBuilder.assemble_toc_secnumbers>` |                         |
+---------------------------------------------------------------------------------------------------------------------------------------+-------------------------+
| :meth:`finish <pyquickhelper.helpgen._single_file_html_builder.CustomSingleFileHTMLBuilder.finish>`                                   |                         |
+---------------------------------------------------------------------------------------------------------------------------------------+-------------------------+
| :meth:`fix_refuris <pyquickhelper.helpgen._single_file_html_builder.CustomSingleFileHTMLBuilder.fix_refuris>`                         |                         |
+---------------------------------------------------------------------------------------------------------------------------------------+-------------------------+
| :meth:`get_doc_context <pyquickhelper.helpgen._single_file_html_builder.CustomSingleFileHTMLBuilder.get_doc_context>`                 |                         |
+---------------------------------------------------------------------------------------------------------------------------------------+-------------------------+
| :meth:`get_outdated_docs <pyquickhelper.helpgen._single_file_html_builder.CustomSingleFileHTMLBuilder.get_outdated_docs>`             |                         |
+---------------------------------------------------------------------------------------------------------------------------------------+-------------------------+
| :meth:`get_relative_uri <pyquickhelper.helpgen._single_file_html_builder.CustomSingleFileHTMLBuilder.get_relative_uri>`               |                         |
+---------------------------------------------------------------------------------------------------------------------------------------+-------------------------+
| :meth:`get_target_uri <pyquickhelper.helpgen._single_file_html_builder.CustomSingleFileHTMLBuilder.get_target_uri>`                   |                         |
+---------------------------------------------------------------------------------------------------------------------------------------+-------------------------+
| :meth:`write <pyquickhelper.helpgen._single_file_html_builder.CustomSingleFileHTMLBuilder.write>`                                     |                         |
+---------------------------------------------------------------------------------------------------------------------------------------+-------------------------+


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

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