.. _f-sphinxblogextension:

module ``sphinxext.sphinx_blog_extension``
==========================================





.. inheritance-diagram:: pyquickhelper.sphinxext.sphinx_blog_extension


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

module ``pyquickhelper.sphinxext.sphinx_blog_extension``

Defines blogpost directives.
See `Tutorial: Writing a simple extension
<https://www.sphinx-doc.org/en/master/development/tutorials/helloworld.html>`_,
`Creating reStructuredText Directives
<https://docutils.sourceforge.io/docs/howto/rst-directives.html>`_


:githublink:`%|py|10`




Classes
+++++++

+------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------+
| class                                                                                                | truncated documentation                                            |
+======================================================================================================+====================================================================+
| :class:`blogpost_node <pyquickhelper.sphinxext.sphinx_blog_extension.blogpost_node>`                 | Defines *blogpost* node.                                           |
+------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------+
| :class:`blogpostagg_node <pyquickhelper.sphinxext.sphinx_blog_extension.blogpostagg_node>`           | Defines *blogpostagg* node.                                        |
+------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------+
| :class:`BlogPostDirective <pyquickhelper.sphinxext.sphinx_blog_extension.BlogPostDirective>`         | Extracts information about a blog post described by a directive `` |
+------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------+
| :class:`BlogPostDirectiveAgg <pyquickhelper.sphinxext.sphinx_blog_extension.BlogPostDirectiveAgg>`   | same but for the same post in a aggregated pages                   |
+------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------+
| :class:`blogpostlist_node <pyquickhelper.sphinxext.sphinx_blog_extension.blogpostlist_node>`         | defines *blogpostlist* node, unused, kept as example               |
+------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------+
| :class:`BlogPostListDirective <pyquickhelper.sphinxext.sphinx_blog_extension.BlogPostListDirective>` | unused, kept as example                                            |
+------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------+




Functions
+++++++++

+-------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| function                                                                                                          | truncated documentation                                                                                               |
+===================================================================================================================+=======================================================================================================================+
| :func:`depart_blogpost_node <pyquickhelper.sphinxext.sphinx_blog_extension.depart_blogpost_node>`                 | what to do when leaving a node blogpost the function should have different behaviour, depending on the format, or ... |
+-------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :func:`depart_blogpostagg_node <pyquickhelper.sphinxext.sphinx_blog_extension.depart_blogpostagg_node>`           | what to do when leaving a node blogpost, the function should have different behaviour, depending on the format, ...   |
+-------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :func:`depart_blogpostagg_node_html <pyquickhelper.sphinxext.sphinx_blog_extension.depart_blogpostagg_node_html>` | what to do when leaving a node blogpost, the function should have different behaviour, depending on the format, ...   |
+-------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :func:`process_blogpost_nodes <pyquickhelper.sphinxext.sphinx_blog_extension.process_blogpost_nodes>`             | unused, kept as example                                                                                               |
+-------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :func:`purge_blogpost <pyquickhelper.sphinxext.sphinx_blog_extension.purge_blogpost>`                             | unused, kept as example                                                                                               |
+-------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :func:`setup <pyquickhelper.sphinxext.sphinx_blog_extension.setup>`                                               | setup for ``blogpost`` (sphinx)                                                                                       |
+-------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :func:`visit_blogpost_node <pyquickhelper.sphinxext.sphinx_blog_extension.visit_blogpost_node>`                   | what to do when visiting a node blogpost the function should have different behaviour, depending on the format, ...   |
+-------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :func:`visit_blogpostagg_node <pyquickhelper.sphinxext.sphinx_blog_extension.visit_blogpostagg_node>`             | what to do when visiting a node blogpost the function should have different behaviour, depending on the format, ...   |
+-------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+




Properties
++++++++++

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






Methods
+++++++

+--------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| method                                                                                                 | truncated documentation                                                                 |
+========================================================================================================+=========================================================================================+
| :meth:`fill_node <pyquickhelper.sphinxext.sphinx_blog_extension.BlogPostDirective.fill_node>`          | Fills the content of the node.                                                          |
+--------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :meth:`fill_node <pyquickhelper.sphinxext.sphinx_blog_extension.BlogPostDirectiveAgg.fill_node>`       | Fill the node of an aggregated page.                                                    |
+--------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :meth:`run <pyquickhelper.sphinxext.sphinx_blog_extension.BlogPostDirective.run>`                      | extracts the information in a dictionary and displays it if the environment is not null |
+--------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :meth:`run <pyquickhelper.sphinxext.sphinx_blog_extension.BlogPostDirectiveAgg.run>`                   | extracts the information in a dictionary and displays it if the environment is not null |
+--------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :meth:`run <pyquickhelper.sphinxext.sphinx_blog_extension.BlogPostListDirective.run>`                  |                                                                                         |
+--------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :meth:`suffix_label <pyquickhelper.sphinxext.sphinx_blog_extension.BlogPostDirective.suffix_label>`    | returns a suffix to add to a label, it should not be empty for aggregated pages         |
+--------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :meth:`suffix_label <pyquickhelper.sphinxext.sphinx_blog_extension.BlogPostDirectiveAgg.suffix_label>` | returns a suffix to add to a label, it should not be empty for aggregated pages         |
+--------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+


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

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