.. _f-sphinxfaqrefextension:

module ``sphinxext.sphinx_faqref_extension``
============================================





.. inheritance-diagram:: pyquickhelper.sphinxext.sphinx_faqref_extension


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

module ``pyquickhelper.sphinxext.sphinx_faqref_extension``

Defines a :epkg:`sphinx` extension to keep track of FAQ.


:githublink:`%|py|6`




Classes
+++++++

+------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+
| class                                                                              | truncated documentation                                                                     |
+====================================================================================+=============================================================================================+
| :class:`FaqRef <pyquickhelper.sphinxext.sphinx_faqref_extension.FaqRef>`           | A ``faqref`` entry, displayed in the form of an admonition. It takes the following options: |
+------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+
| :class:`faqref_node <pyquickhelper.sphinxext.sphinx_faqref_extension.faqref_node>` | defines ``faqref`` ndoe                                                                     |
+------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+
| :class:`FaqRefList <pyquickhelper.sphinxext.sphinx_faqref_extension.FaqRefList>`   | A list of all *faqref* entries, for a specific tag.                                         |
+------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+
| :class:`faqreflist <pyquickhelper.sphinxext.sphinx_faqref_extension.faqreflist>`   | defines ``faqreflist`` node                                                                 |
+------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+




Functions
+++++++++

+---------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| function                                                                                                | truncated documentation                                                                                              |
+=========================================================================================================+======================================================================================================================+
| :func:`depart_faqref_node <pyquickhelper.sphinxext.sphinx_faqref_extension.depart_faqref_node>`         | depart_faqref_node, see https://github.com/sphinx-doc/sphinx/blob/master/sphinx/writers/html.py                      |
+---------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :func:`depart_faqreflist_node <pyquickhelper.sphinxext.sphinx_faqref_extension.depart_faqreflist_node>` | depart_faqref_node                                                                                                   |
+---------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :func:`merge_faqref <pyquickhelper.sphinxext.sphinx_faqref_extension.merge_faqref>`                     | merge_faqref                                                                                                         |
+---------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :func:`process_faqref_nodes <pyquickhelper.sphinxext.sphinx_faqref_extension.process_faqref_nodes>`     | process_faqref_nodes                                                                                                 |
+---------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :func:`process_faqrefs <pyquickhelper.sphinxext.sphinx_faqref_extension.process_faqrefs>`               | collect all *faqref* in the environment this is not done in the directive itself because it some transformations ... |
+---------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :func:`purge_faqrefs <pyquickhelper.sphinxext.sphinx_faqref_extension.purge_faqrefs>`                   | purge_faqrefs                                                                                                        |
+---------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :func:`setup <pyquickhelper.sphinxext.sphinx_faqref_extension.setup>`                                   | setup for ``faqref`` (sphinx)                                                                                        |
+---------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :func:`visit_faqref_node <pyquickhelper.sphinxext.sphinx_faqref_extension.visit_faqref_node>`           | visit_faqref_node                                                                                                    |
+---------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :func:`visit_faqreflist_node <pyquickhelper.sphinxext.sphinx_faqref_extension.visit_faqreflist_node>`   | visit_faqreflist_node see https://github.com/sphinx-doc/sphinx/blob/master/sphinx/writers/html.py                    |
+---------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+




Properties
++++++++++

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






Methods
+++++++

+------------------------------------------------------------------------------+------------------------------------------------------------------------+
| method                                                                       | truncated documentation                                                |
+==============================================================================+========================================================================+
| :meth:`run <pyquickhelper.sphinxext.sphinx_faqref_extension.FaqRef.run>`     | calls run from :class:`BlocRef` and add defaut tag                     |
+------------------------------------------------------------------------------+------------------------------------------------------------------------+
| :meth:`run <pyquickhelper.sphinxext.sphinx_faqref_extension.FaqRefList.run>` | calls run from :class:`BlocRefList` and add default tag if not present |
+------------------------------------------------------------------------------+------------------------------------------------------------------------+


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

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