.. _f-sphinxtemplateextension:

module ``sphinxext.sphinx_template_extension``
==============================================





.. inheritance-diagram:: pyquickhelper.sphinxext.sphinx_template_extension


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

module ``pyquickhelper.sphinxext.sphinx_template_extension``

Defines a sphinx extension ``tpl``, a role which use templating.


:githublink:`%|py|6`




Classes
+++++++

+--------------------------------------------------------------------------------------+-------------------------+
| class                                                                                | truncated documentation |
+======================================================================================+=========================+
| :class:`ClassStruct <pyquickhelper.sphinxext.sphinx_template_extension.ClassStruct>` | Class as struct.        |
+--------------------------------------------------------------------------------------+-------------------------+
| :class:`tpl_node <pyquickhelper.sphinxext.sphinx_template_extension.tpl_node>`       | Defines *tpl* node.     |
+--------------------------------------------------------------------------------------+-------------------------+




Functions
+++++++++

+-------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------+
| function                                                                                        | truncated documentation                                                            |
+=================================================================================================+====================================================================================+
| :func:`depart_tpl_node <pyquickhelper.sphinxext.sphinx_template_extension.depart_tpl_node>`     | What to do when leaving a node *tpl*.                                              |
+-------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------+
| :func:`evaluate_template <pyquickhelper.sphinxext.sphinx_template_extension.evaluate_template>` | Evaluate a template given a list of parameters given a list of named parameters.   |
+-------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------+
| :func:`setup <pyquickhelper.sphinxext.sphinx_template_extension.setup>`                         | setup for ``bigger`` (sphinx)                                                      |
+-------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------+
| :func:`tpl_role <pyquickhelper.sphinxext.sphinx_template_extension.tpl_role>`                   | Defines custom role *tpl*. A template must be specified in the configuration file. |
+-------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------+
| :func:`visit_tpl_node <pyquickhelper.sphinxext.sphinx_template_extension.visit_tpl_node>`       | What to do when visiting a node *tpl*.                                             |
+-------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------+




Properties
++++++++++

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






Methods
+++++++

+----------------------------------------------------------------------------------------------+---------------------------------------+
| method                                                                                       | truncated documentation               |
+==============================================================================================+=======================================+
| :py:meth:`__init__ <pyquickhelper.sphinxext.sphinx_template_extension.ClassStruct.__init__>` | All arguments are added to the class. |
+----------------------------------------------------------------------------------------------+---------------------------------------+


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

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