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.

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Latest release

2 maintainers

PyPI data
Data sourced directly from PyPI's database.
Avatar for akcano from gravatar.com akcano Avatar for ecoldi from gravatar.com ecoldi

License expression

GPL-3.0
View SPDX License List

Requires

Python >=3.10

Report project as malware

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sphinx_youtube_links-0.1.0.tar.gz (112.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

sphinx_youtube_links-0.1.0-py3-none-any.whl (17.6 kB view details)

Uploaded Python 3

File details

Details for the file sphinx_youtube_links-0.1.0.tar.gz.

File metadata

  • Download URL: sphinx_youtube_links-0.1.0.tar.gz
  • Upload date:
  • Size: 112.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for sphinx_youtube_links-0.1.0.tar.gz
Algorithm Hash digest
SHA256 81cf804cbaacc0c9407b606b6d27a398d4db3617b386b1ce419ee335a6393b26
MD5 3635a8195adc5322ff6af22e4baf8e72
BLAKE2b-256 45ae73e66ab34cda6236dce91b9ed02776ba6ba206f0e81371b921e16e574e9d

See more details on using hashes here.

Provenance

The following attestation bundles were made for sphinx_youtube_links-0.1.0.tar.gz:

Publisher: release-publish.yaml on canonical/sphinx-youtube-links

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file sphinx_youtube_links-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for sphinx_youtube_links-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 4c6657abb3c5a2f93b6810093c249e4d775617fccd35588ef5d40263c60d6ab3
MD5 e3437bd684010f0086d247fcd9cca386
BLAKE2b-256 cb99dbc4a2db3e546003c2a7b6d14b6abbeb7e85eb3f7668a11461897351039e

See more details on using hashes here.

Provenance

The following attestation bundles were made for sphinx_youtube_links-0.1.0-py3-none-any.whl:

Publisher: release-publish.yaml on canonical/sphinx-youtube-links

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

This release

0.1.0 This release

2 files

0.0.3

2 files

0.0.2

2 files

0.0.1

2 files

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