Skip to main content

sphinx-youtube-links

sphinx-youtube-links adds a Sphinx directive that creates styled YouTube video links with automatic title extraction.

Basic usage

To add a YouTube link to your document, use the youtube directive with the desired YouTube URL:

.. youtube:: https://www.youtube.com/watch?v=dQw4w9WgXcQ

You can also specify a custom title:

.. youtube:: https://www.youtube.com/watch?v=dQw4w9WgXcQ
   :title: Custom Video Title

Project setup

sphinx-youtube-links is published on PyPI and can be installed with:

pip install sphinx-youtube-links

After adding sphinx-youtube-links to your Python project, update your Sphinx's conf.py file to include sphinx-youtube-links as one of its extensions:

extensions = [
    "sphinx_youtube_links"
]

Community and support

You can report any issues or bugs on the project's GitHub repository.

youtube-links is covered by the Ubuntu Code of Conduct.

License and copyright

youtube-links is released under the GPL-3.0 license.

© 2025 Canonical Ltd.

Metadata

Release files for sphinx-youtube-links 0.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for sphinx-youtube-links 0.1.0
File Size Uploaded Provenance Actions
sphinx_youtube_links-0.1.0.tar.gz 112.1 kB With provenance Details for sphinx_youtube_links-0.1.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for sphinx-youtube-links 0.1.0
File Interpreter ABI Platform Actions
sphinx_youtube_links-0.1.0-py3-none-any.whl Python 3 none any Details for sphinx_youtube_links-0.1.0-py3-none-any.whl

Total release size: 129.7 kB

Security for sphinx-youtube-links 0.1.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

All 2 files in this release have been uploaded with provenance metadata.

Select from 2 files

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page