.. _f-sphinxcollapseextension:

module ``sphinxext.sphinx_collapse_extension``
==============================================





.. inheritance-diagram:: pyquickhelper.sphinxext.sphinx_collapse_extension


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

module ``pyquickhelper.sphinxext.sphinx_collapse_extension``

Defines a sphinx extension to hide / unhide
section of the page.


:githublink:`%|py|7`




Classes
+++++++

+--------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+
| class                                                                                            | truncated documentation                                                                            |
+==================================================================================================+====================================================================================================+
| :class:`collapse_node <pyquickhelper.sphinxext.sphinx_collapse_extension.collapse_node>`         | defines ``collapse`` node.                                                                         |
+--------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+
| :class:`CollapseDirective <pyquickhelper.sphinxext.sphinx_collapse_extension.CollapseDirective>` | A ``collapse`` adds hide/unhide button for a part of HTML page. It has no effect in other formats. |
+--------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+




Functions
+++++++++

+-----------------------------------------------------------------------------------------------------------------+---------------------------------+
| function                                                                                                        | truncated documentation         |
+=================================================================================================================+=================================+
| :func:`depart_collapse_node <pyquickhelper.sphinxext.sphinx_collapse_extension.depart_collapse_node>`           | depart collapse_node            |
+-----------------------------------------------------------------------------------------------------------------+---------------------------------+
| :func:`depart_collapse_node_html <pyquickhelper.sphinxext.sphinx_collapse_extension.depart_collapse_node_html>` | depart collapse_node            |
+-----------------------------------------------------------------------------------------------------------------+---------------------------------+
| :func:`depart_collapse_node_rst <pyquickhelper.sphinxext.sphinx_collapse_extension.depart_collapse_node_rst>`   | depart collapse_node            |
+-----------------------------------------------------------------------------------------------------------------+---------------------------------+
| :func:`setup <pyquickhelper.sphinxext.sphinx_collapse_extension.setup>`                                         | setup for ``collapse`` (sphinx) |
+-----------------------------------------------------------------------------------------------------------------+---------------------------------+
| :func:`visit_collapse_node <pyquickhelper.sphinxext.sphinx_collapse_extension.visit_collapse_node>`             | visit collapse_node             |
+-----------------------------------------------------------------------------------------------------------------+---------------------------------+
| :func:`visit_collapse_node_html <pyquickhelper.sphinxext.sphinx_collapse_extension.visit_collapse_node_html>`   | visit collapse_node             |
+-----------------------------------------------------------------------------------------------------------------+---------------------------------+
| :func:`visit_collapse_node_rst <pyquickhelper.sphinxext.sphinx_collapse_extension.visit_collapse_node_rst>`     | visit collapse_node             |
+-----------------------------------------------------------------------------------------------------------------+---------------------------------+




Properties
++++++++++

+---------------------------------------------------------------------------------------------+-------------------------------------------------------------------+
| property                                                                                    | truncated documentation                                           |
+=============================================================================================+===================================================================+
| :meth:`document <pyquickhelper.sphinxext.sphinx_collapse_extension.collapse_node.document>` | Return the `document` root node of the tree containing this Node. |
+---------------------------------------------------------------------------------------------+-------------------------------------------------------------------+






Methods
+++++++

+---------------------------------------------------------------------------------------+---------------------------+
| method                                                                                | truncated documentation   |
+=======================================================================================+===========================+
| :meth:`run <pyquickhelper.sphinxext.sphinx_collapse_extension.CollapseDirective.run>` | Builds the collapse text. |
+---------------------------------------------------------------------------------------+---------------------------+


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

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