.. _f-sphinxyoutubeextension:

module ``sphinxext.sphinx_youtube_extension``
=============================================





.. inheritance-diagram:: pyquickhelper.sphinxext.sphinx_youtube_extension


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

module ``pyquickhelper.sphinxext.sphinx_youtube_extension``

Inspired from `sphinxcontrib.youtube <https://github.com/thewtex/sphinx-contrib/blob/master/youtube/sphinxcontrib/youtube.py>`_
(not maintained anymore).


:githublink:`%|py|7`




Classes
+++++++

+-----------------------------------------------------------------------------------------------+-------------------------+
| class                                                                                         | truncated documentation |
+===============================================================================================+=========================+
| :class:`youtube_node <pyquickhelper.sphinxext.sphinx_youtube_extension.youtube_node>`         | Youtube node.           |
+-----------------------------------------------------------------------------------------------+-------------------------+
| :class:`YoutubeDirective <pyquickhelper.sphinxext.sphinx_youtube_extension.YoutubeDirective>` | Youtube directive.      |
+-----------------------------------------------------------------------------------------------+-------------------------+




Functions
+++++++++

+----------------------------------------------------------------------------------------------------+------------------------------+
| function                                                                                           | truncated documentation      |
+====================================================================================================+==============================+
| :func:`css <pyquickhelper.sphinxext.sphinx_youtube_extension.css>`                                 | Returns style.               |
+----------------------------------------------------------------------------------------------------+------------------------------+
| :func:`depart_youtube_node <pyquickhelper.sphinxext.sphinx_youtube_extension.depart_youtube_node>` | Youtube node.                |
+----------------------------------------------------------------------------------------------------+------------------------------+
| :func:`get_size <pyquickhelper.sphinxext.sphinx_youtube_extension.get_size>`                       | Get size.                    |
+----------------------------------------------------------------------------------------------------+------------------------------+
| :func:`setup <pyquickhelper.sphinxext.sphinx_youtube_extension.setup>`                             | Setup for youtube extension. |
+----------------------------------------------------------------------------------------------------+------------------------------+
| :func:`visit_youtube_node <pyquickhelper.sphinxext.sphinx_youtube_extension.visit_youtube_node>`   | Visit youtube node (html).   |
+----------------------------------------------------------------------------------------------------+------------------------------+




Properties
++++++++++

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






Methods
+++++++

+-------------------------------------------------------------------------------------+-------------------------+
| method                                                                              | truncated documentation |
+=====================================================================================+=========================+
| :meth:`run <pyquickhelper.sphinxext.sphinx_youtube_extension.YoutubeDirective.run>` |                         |
+-------------------------------------------------------------------------------------+-------------------------+


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

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