What is sphinxcontrib-youtube?

sphinxcontrib-youtube is a small plugin that lets you embed YouTube, Vimeo, and Peertube videos directly into documentation pages built with Sphinx. Sphinx is a popular documentation generator used by many open-source and technical projects, and this extension fills a straightforward gap: making it easy to place a playable video right inside a help doc, tutorial, or reference page. Using it is deliberately simple. Instead of dealing with embed codes or HTML snippets, you just add a short line to your document that names the platform and the video's ID. For example, writing a single line with the word "youtube" followed by a video ID will render that video when the documentation is built. The same approach works for Vimeo and Peertube, and Peertube instances on custom servers are supported too by specifying which server to pull from. The people who would use this are teams or individuals already writing documentation in reStructuredText and building it with Sphinx. A practical example: a software project that wants to include short tutorial videos alongside written setup instructions, or a course creator who hosts video lessons on YouTube and wants them viewable directly inside the documentation site rather than sending readers elsewhere. What's notable is how minimal and focused the project is. It does one thing, embed videos from three platforms, without unnecessary complexity. The README doesn't go into much detail beyond the basics, but the project points to fuller web documentation for anyone who needs it. It's a utility built for a specific need within the Sphinx ecosystem, and it keeps the barrier to entry very low for documentation authors who just want to drop a video into a page.