A Sphinx extension for embedding YouTube video links.
Project description
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.
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file sphinx_youtube_links-0.0.3.tar.gz.
File metadata
- Download URL: sphinx_youtube_links-0.0.3.tar.gz
- Upload date:
- Size: 77.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
5bacab4e22726f2f9446961bd76544dd388eeb3e6dbfee80dccb72f2c31e4323
|
|
| MD5 |
fcc59fbd2c23aa39468e2c8deec57a88
|
|
| BLAKE2b-256 |
fd5eafed8c8a157e0610beb11e4a51191ccbaae1a77126f1165ffccf87bec0cd
|
Provenance
The following attestation bundles were made for sphinx_youtube_links-0.0.3.tar.gz:
Publisher:
release-publish.yaml on canonical/sphinx-youtube-links
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
sphinx_youtube_links-0.0.3.tar.gz -
Subject digest:
5bacab4e22726f2f9446961bd76544dd388eeb3e6dbfee80dccb72f2c31e4323 - Sigstore transparency entry: 602139844
- Sigstore integration time:
-
Permalink:
canonical/sphinx-youtube-links@761081ce38f6b8efb74a1977eb5606d2bb1f3b63 -
Branch / Tag:
refs/tags/0.0.3 - Owner: https://github.com/canonical
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
self-hosted -
Publication workflow:
release-publish.yaml@761081ce38f6b8efb74a1977eb5606d2bb1f3b63 -
Trigger Event:
push
-
Statement type:
File details
Details for the file sphinx_youtube_links-0.0.3-py3-none-any.whl.
File metadata
- Download URL: sphinx_youtube_links-0.0.3-py3-none-any.whl
- Upload date:
- Size: 17.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
694176c0447da84263a90fc6c621368a73e4d78a4d2f50d077409e124c7e8aae
|
|
| MD5 |
6237e72e45ddaa04aee13377691569a3
|
|
| BLAKE2b-256 |
0448c31b917f65b4d6661d18009f42528382c4e4a0a8ec8a5205923fcf261f1a
|
Provenance
The following attestation bundles were made for sphinx_youtube_links-0.0.3-py3-none-any.whl:
Publisher:
release-publish.yaml on canonical/sphinx-youtube-links
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
sphinx_youtube_links-0.0.3-py3-none-any.whl -
Subject digest:
694176c0447da84263a90fc6c621368a73e4d78a4d2f50d077409e124c7e8aae - Sigstore transparency entry: 602139845
- Sigstore integration time:
-
Permalink:
canonical/sphinx-youtube-links@761081ce38f6b8efb74a1977eb5606d2bb1f3b63 -
Branch / Tag:
refs/tags/0.0.3 - Owner: https://github.com/canonical
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
self-hosted -
Publication workflow:
release-publish.yaml@761081ce38f6b8efb74a1977eb5606d2bb1f3b63 -
Trigger Event:
push
-
Statement type:
