.. _f-sphinxvideoextension:

module ``sphinxext.sphinx_video_extension``
===========================================





.. inheritance-diagram:: pyquickhelper.sphinxext.sphinx_video_extension


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

module ``pyquickhelper.sphinxext.sphinx_video_extension``

Defines a sphinx extension to add button to share a page


:githublink:`%|py|6`




Classes
+++++++

+-----------------------------------------------------------------------------------------+------------------------------------------------+
| class                                                                                   | truncated documentation                        |
+=========================================================================================+================================================+
| :class:`video_node <pyquickhelper.sphinxext.sphinx_video_extension.video_node>`         | Defines *video* node.                          |
+-----------------------------------------------------------------------------------------+------------------------------------------------+
| :class:`VideoDirective <pyquickhelper.sphinxext.sphinx_video_extension.VideoDirective>` | Adds video to a page. It can be done by adding |
+-----------------------------------------------------------------------------------------+------------------------------------------------+




Functions
+++++++++

+------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| function                                                                                                         | truncated documentation                                                                                              |
+==================================================================================================================+======================================================================================================================+
| :func:`_clean_value <pyquickhelper.sphinxext.sphinx_video_extension._clean_value>`                               |                                                                                                                      |
+------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :func:`depart_video_node_html <pyquickhelper.sphinxext.sphinx_video_extension.depart_video_node_html>`           | What to do when leaving a node *video* the function should have different behaviour, depending on the format, or ... |
+------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :func:`depart_video_node_latex <pyquickhelper.sphinxext.sphinx_video_extension.depart_video_node_latex>`         | What to do when leaving a node *video* the function should have different behaviour, depending on the format, or ... |
+------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :func:`depart_video_node_rst <pyquickhelper.sphinxext.sphinx_video_extension.depart_video_node_rst>`             | What to do when leaving a node *video* the function should have different behaviour, depending on the format, or ... |
+------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :func:`depart_video_node_text <pyquickhelper.sphinxext.sphinx_video_extension.depart_video_node_text>`           | What to do when leaving a node *video* the function should have different behaviour, depending on the format, or ... |
+------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :func:`initialize_videos_directive <pyquickhelper.sphinxext.sphinx_video_extension.initialize_videos_directive>` | Initializes the video directives.                                                                                    |
+------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :func:`setup <pyquickhelper.sphinxext.sphinx_video_extension.setup>`                                             | setup for ``video`` (sphinx)                                                                                         |
+------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :func:`visit_video_node <pyquickhelper.sphinxext.sphinx_video_extension.visit_video_node>`                       | Visits a video node. Copies the video.                                                                               |
+------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+




Properties
++++++++++

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






Methods
+++++++

+---------------------------------------------------------------------------------+-------------------------+
| method                                                                          | truncated documentation |
+=================================================================================+=========================+
| :meth:`run <pyquickhelper.sphinxext.sphinx_video_extension.VideoDirective.run>` | Runs the directive.     |
+---------------------------------------------------------------------------------+-------------------------+


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

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