sphinxcontrib-video
Allows embedding of HTML5 videos in sphinx
Decision gist · record as of 2026-08-14
Yes, if you are building Sphinx documentation and want to embed HTML5 videos without writing custom HTML. The extension is simple, has low install friction, and carries no security vulnerabilities. The aging maintenance status means you should verify compatibility with your Sphinx version and expect slower response to new issues, but the core functionality is stable and the repository is not abandoned.AI-flagged interpretation of the facts on this page — verify before relying
Before you install
- Requires Sphinx to be installed and configured; requires Python 3.9.0 or later.
- Low friction installation with a single dependency on Sphinx.
- Maintenance status is aging—last commit was 2026-01-14 and the project has not released since then, though the repository remains active and not archived.
License · maintenance · safety
Apache Software License (permissive) — Licensed under Apache Software License (permissive), so you can use and modify it freely in most contexts without significant legal restrictions.
last release 2026-01-14 (212 days) · last repo commit 2026-01-14 · 51 stars
0 known vulnerabilities (OSV.dev, 2026-08-14) · 315,414 downloads/mo, #7,686 on PyPI
Alternatives
Verify before relying
pip install sphinxcontrib-video
In conf.py:
extensions = ['sphinxcontrib_video']
In your .rst file:
.. video:: movie.mp4- Whether the extension works with all current Sphinx versions or only specific releases
- Browser compatibility for the HTML5 video tag output across different target environments
- Performance or limitations when embedding many videos in a single documentation build
What it is and what it does
sphinxcontrib-video is a Sphinx extension that lets you embed HTML5 videos directly into Sphinx-generated documentation. You write a simple reStructuredText directive (e.g., `.. video:: movie.mp4`) and it renders as an HTML5 `<video>` tag with support for .mp4, .webm, and .ogg formats. The extension exposes the full parameter set from the HTML5 video standard, so you can control playback behavior, dimensions, autoplay, and other video properties through directive options.
The package is a thin wrapper around HTML5 video semantics, designed for documentation authors who want to include video content without writing raw HTML. It depends only on Sphinx, so installation is straightforward. The project is classified as Alpha and has been aging since its last release, but the repository remains maintained and carries no known security vulnerabilities.
Use it for
- Embed tutorial or demo videos directly in API or user documentation
- Include video walkthroughs in software project README or guide pages
- Add product demo or feature showcase videos to technical documentation builds
- Embed screen recordings as HTML5 video in Sphinx docs
- Create multimedia-rich documentation for tools or frameworks with visual components
Worth the install?
AI-flagged interpretation of the facts on this page. Verify before relying on it.
Yes, if you are building Sphinx documentation and want to embed HTML5 videos without writing custom HTML.
The extension is simple, has low install friction, and carries no security vulnerabilities. The aging maintenance status means you should verify compatibility with your Sphinx version and expect slower response to new issues, but the core functionality is stable and the repository is not abandoned.
Install
sphinxcontrib-video on PyPI
Before you install
Low friction installation with a single dependency on Sphinx. Maintenance status is aging—last commit was 2026-01-14 and the project has not released since then, though the repository remains active and not archived.
Requires Sphinx to be installed and configured; requires Python 3.9.0 or later.
License in practice
Licensed under Apache Software License (permissive), so you can use and modify it freely in most contexts without significant legal restrictions.
Quickstart
pip install sphinxcontrib-video
In conf.py:
extensions = ['sphinxcontrib_video']
In your .rst file:
.. video:: movie.mp4Verify before relying
- Whether the extension works with all current Sphinx versions or only specific releases
- Browser compatibility for the HTML5 video tag output across different target environments
- Performance or limitations when embedding many videos in a single documentation build
Package facts
| License | Apache Software License permissive |
| Python support | Supports the current Python release >=3.9.0 |
| Install friction | Low. Pure-Python wheel |
| Runtime dependencies | 1 packagesphinx |
| Maintenance | Aging 212 days since the last release |
| Last repo commit | |
| First released | |
| Downloads | 315,414 / month, #7,686 on PyPI 30-day window, as of 2026-08-14 |
| Known vulnerabilities | None known OSV.dev, checked 2026-08-14 |
| Classifiers | Development Status :: 3 - AlphaFramework :: Sphinx :: ExtensionIntended Audience :: DevelopersLicense :: OSI Approved :: Apache Software LicenseOperating System :: OS IndependentProgramming Language :: PythonProgramming Language :: Python :: 3Programming Language :: Python :: 3.10Programming Language :: Python :: 3.11Programming Language :: Python :: 3.12Programming Language :: Python :: 3.13Programming Language :: Python :: 3.9Topic :: DocumentationTopic :: Utilities |
Evidence: sphinxcontrib_video-0.4.2-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 embed”
- sphinxcontrib-videoA Sphinx extension that embeds HTML5 videos (.mp4, .webm, .ogg) in…
- sphinxcontrib-youtubeAdds Sphinx directives to embed YouTube, Vimeo, and Peertube videos…
- sphinxcontrib-mermaidEmbeds Mermaid diagrams (flowcharts, sequence diagrams, Gantt charts,…
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 sphinxcontrib-youtube · sphinxcontrib-images · sphinx_mdinclude · django-embed-video · mkdocs-video · sphinx-jinja · pymp4 · micawber · sphinxcontrib-jquery · sphinxcontrib-towncrier