:html_theme.sidebar_secondary.remove:

sphinxcontrib-youtube
=====================

.. toctree::
   :hidden:

   usage
   contribute

Overview
--------

This module provides support for including YouTube, Vimeo and PeerTube videos in Sphinx rst documents.

This module defines directives, youtube, vimeo and peertube which insert videos from the respective platforms. They take a single, required argument, which is the video ID:

.. code-block:: rst

    ..  youtube:: dQw4w9WgXcQ

..  youtube:: dQw4w9WgXcQ

Documentation contents
----------------------

.. grid:: 1 2 2 2

   .. grid-item::

      .. card:: Getting started
         :link: usage.html

         Usage and installation

   .. grid-item::

      .. card:: Contribute
         :link: contribute.html

         Help us improve the library.
