https://github.com/sphinx-contrib/youtube

A Sphinx extension to embed videos from YouTube
https://github.com/sphinx-contrib/youtube

sphinx-extension

Last synced: about 1 month ago
JSON representation

A Sphinx extension to embed videos from YouTube

• Host: GitHub
• URL: https://github.com/sphinx-contrib/youtube
• Owner: sphinx-contrib
• License: bsd-3-clause
• Created: 2017-09-28T15:04:56.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2023-09-22T12:00:53.000Z (over 1 year ago)
• Last Synced: 2025-03-30T18:08:47.429Z (about 1 month ago)
• Topics: sphinx-extension
• Language: Python
• Homepage:
• Size: 79.1 KB
• Stars: 55
• Watchers: 4
• Forks: 36
• Open Issues: 5
• Metadata Files:
  • Readme: README.rst

Awesome Lists containing this project

README

        
sphinxcontrib.youtube

=====================

.. image:: https://img.shields.io/badge/License-BSD_3--Clause-orange.svg

    :alt: license

    :target: LICENCE

.. image:: https://badge.fury.io/py/sphinxcontrib-youtube.svg

    :target: https://badge.fury.io/py/sphinxcontrib-youtube

    :alt: PyPi version

Overview

--------

This module provides support for including YouTube, Vimeo and Peertube videos in Sphinx

:code:`rst` documents.

This module defines directives, :code:`youtube`, :code:`vimeo` and :code:`peertube` which insert

videos from the respective platforms. They take a single, required argument,

which is the video ID:

.. code-block:: rst

   ..  youtube:: dQw4w9WgXcQ

.. code-block:: rst

   .. vimeo:: 148751763

.. code-block:: rst

   .. peertube:: 327a21b3-374e-4373-8b2c-494c9f5e1f19

Custom Server for peertube instances:

.. code-block:: rst

   .. peertube:: 327a21b3-374e-4373-8b2c-494c9f5e1f19

      :instance: peertube.tv

For full usage information, please see the `web documentation

`__.