sphinxcontrib-youtube
Sphinx "youtube" extension.
Decision gist · record as of 2026-08-14
Yes. This is a lightweight, actively maintained Sphinx extension with low install friction, no security issues, and a permissive license. Install it if you need to embed videos in Sphinx documentation; skip it if your docs are text-only or you prefer external video links.AI-flagged interpretation of the facts on this page — verify before relying
Before you install
- Low friction install with only Sphinx and requests as runtime dependencies.
- Active maintenance with a recent release and a stable codebase.
License · maintenance · safety
permissive license (permissive) — Permissive license means you can use this in commercial and private projects without restriction.
last release 2026-04-01 (135 days) · last repo commit 2026-04-01 · 56 stars
0 known vulnerabilities (OSV.dev, 2026-08-14) · 297,075 downloads/mo, #7,891 on PyPI
Alternatives
Verify before relying
pip install sphinxcontrib-youtube
In conf.py:
extensions = ['sphinxcontrib.youtube']
In your .rst file:
.. youtube:: dQw4w9WgXcQ- Whether the package supports modern Sphinx versions and any recent breaking changes in Sphinx's extension API.
- Performance characteristics when embedding many videos in a single documentation build.
What it is and what it does
sphinxcontrib-youtube is a Sphinx extension that lets you embed videos from YouTube, Vimeo, and Peertube directly into reStructuredText documentation using simple directives. Instead of linking to videos externally, you can include them inline in your docs, and they render as embedded players in the final HTML output. It depends on Sphinx and requests, both widely used and stable.
You use it by adding the extension to your Sphinx conf.py, then writing directives like `.. youtube:: VIDEO_ID` in your .rst files. For Peertube, you can specify a custom instance URL. The package has been actively maintained and carries no known security vulnerabilities, making it a straightforward choice for documentation projects that want to include video content.
Use it for
- Embed YouTube videos in Sphinx documentation to supplement written tutorials or guides.
- Include Vimeo videos in technical documentation for organizations that host content on Vimeo.
- Add Peertube videos to documentation for projects using decentralized video hosting.
- Create rich media documentation sites that combine text, code examples, and embedded video content.
Worth the install?
AI-flagged interpretation of the facts on this page. Verify before relying on it.
Yes.
This is a lightweight, actively maintained Sphinx extension with low install friction, no security issues, and a permissive license. Install it if you need to embed videos in Sphinx documentation; skip it if your docs are text-only or you prefer external video links.
Install
sphinxcontrib-youtube on PyPI
Before you install
Low friction install with only Sphinx and requests as runtime dependencies. Active maintenance with a recent release and a stable codebase.
License in practice
Permissive license means you can use this in commercial and private projects without restriction.
Quickstart
pip install sphinxcontrib-youtube
In conf.py:
extensions = ['sphinxcontrib.youtube']
In your .rst file:
.. youtube:: dQw4w9WgXcQVerify before relying
- Whether the package supports modern Sphinx versions and any recent breaking changes in Sphinx's extension API.
- Performance characteristics when embedding many videos in a single documentation build.
Package facts
| License | permissive license permissive |
| Python support | Not specified |
| Install friction | Low. Pure-Python wheel |
| Runtime dependencies | 2 packagesSphinxrequests |
| Maintenance | Actively maintained 135 days since the last release |
| Last repo commit | |
| First released | |
| Downloads | 297,075 / month, #7,891 on PyPI 30-day window, as of 2026-08-14 |
| Known vulnerabilities | None known OSV.dev, checked 2026-08-14 |
| Classifiers | Development Status :: 5 - Production/StableEnvironment :: ConsoleEnvironment :: Web EnvironmentFramework :: Sphinx :: ExtensionIntended Audience :: DevelopersLicense :: OSI Approved :: BSD LicenseOperating System :: OS IndependentProgramming Language :: PythonTopic :: DocumentationTopic :: Utilities |
Evidence: sphinxcontrib_youtube-1.5.0-py2.py3-none-any.whl
Tags
Let your AI agent find packages like this
Example. Real query, live index.
You found this page by searching. An agent finds it by wishing: SkillFed indexes 14,416 PyPI packages by what they can do, searchable in plain language.
wish › “sphinx video embedding”
- sphinxcontrib-youtubeAdds Sphinx directives to embed YouTube, Vimeo, and Peertube videos…
- sphinxcontrib-videoA Sphinx extension that embeds HTML5 videos (.mp4, .webm, .ogg) in…
- sphinxcontrib-programoutputA Sphinx extension that executes arbitrary shell commands and embeds…
Give your agent the search over MCP, or paste the wish link into any chat.
More Utilities packages
Converts domain names between Unicode and ASCII-compatible encoding (Punycode) according to IDNA 2008 and Unicode Technical Standard 46, with security validation and broader script coverage than the standard library.
Install it if you work with internationalized domain names, need to validate domains, or use HTTP clients that depend on it transitively.
Detects and normalizes text encoding from unknown or ambiguous sources, supporting all IANA character sets that Python's core library provides codecs for, with the ability to register custom codecs.
Setuptools is a Python build backend and package management tool that handles building, distributing, and installing Python packages, including support for C/C++ extension modules.
Pluggy provides a plugin system that lets you define hook specifications and register implementations to be called in sequence, enabling extensible Python applications without tight coupling.
Install it if you're building an extensible application or framework.
Pygments is a syntax highlighter that colorizes source code and text in over 500 languages and formats, outputting to HTML, LaTeX, RTF, SVG, images, or ANSI terminal sequences.
Install it if you need to display or transform source code.
Six provides utility functions to write Python code that runs on both Python 2.7 and Python 3.3+, smoothing over language differences between the two versions.
See also django-embed-video · sphinx-plotly-directive · sphinxcontrib-video · sphinx_mdinclude · micawber · pybtex-docutils · sphinxcontrib-images · nbsphinx-link · m2r2 · sphinx-jinja