From cc2c08dd7a07b6df78f2ec214a216efde17551d3 Mon Sep 17 00:00:00 2001 From: Hsiaoming Yang Date: Mon, 26 Aug 2024 20:32:47 +0900 Subject: [PATCH] docs: update video url --- docs/contributing/roadmap.rst | 3 +++ docs/writing/media.rst | 32 ++++++++++++++++++++------------ 2 files changed, 23 insertions(+), 12 deletions(-) diff --git a/docs/contributing/roadmap.rst b/docs/contributing/roadmap.rst index 1f23216..ba9583b 100644 --- a/docs/contributing/roadmap.rst +++ b/docs/contributing/roadmap.rst @@ -42,6 +42,9 @@ Make sure it works well with other extensions. Currently integrated with: - :bdg-success:`DONE` :ref:`sphinxcontrib-mermaid` - :bdg-success:`DONE` :ref:`sphinx-sqlalchemy` - :bdg-success:`DONE` :ref:`sphinx-click` +- :bdg-success:`DONE` :ref:`sphinx-click` +- :bdg-success:`DONE` :ref:`sphinxcontrib-video` +- :bdg-success:`DONE` :ref:`sphinxcontrib-youtube` Instant search -------------- diff --git a/docs/writing/media.rst b/docs/writing/media.rst index 014d9ce..8ecd5eb 100644 --- a/docs/writing/media.rst +++ b/docs/writing/media.rst @@ -183,11 +183,13 @@ Videos There is no built-in ``video`` directive for Sphinx. But you can use these extensions instead: -- `sphinxcontrib-video `_ -- `sphinxcontrib-youtube `_ +.. _sphinxcontrib-video: -Video -~~~~~ +sphinxcontrib-video +~~~~~~~~~~~~~~~~~~~ + +- **Documentation**: https://sphinxcontrib-video.readthedocs.io/ +- **Source Code**: https://github.com/sphinx-contrib/video Here is an example of ``video`` directive: @@ -196,14 +198,20 @@ Here is an example of ``video`` directive: .. code-block:: none :class: demo-code - .. video:: https://sphinxcontrib-video.readthedocs.io/en/latest/_images/video.mp4 + .. video:: https://interactive-examples.mdn.mozilla.net/media/cc0-videos/flower.webm .. container:: demo-result - .. video:: https://sphinxcontrib-video.readthedocs.io/en/latest/_images/video.mp4 + .. video:: https://interactive-examples.mdn.mozilla.net/media/cc0-videos/flower.webm + + +.. _sphinxcontrib-youtube: + +sphinxcontrib-youtube +~~~~~~~~~~~~~~~~~~~~~ -YouTube -~~~~~~~ +- **Documentation**: https://sphinxcontrib-youtube.readthedocs.io/ +- **Source Code**: https://github.com/sphinx-contrib/youtube Here is an example of ``youtube`` directive: @@ -234,7 +242,7 @@ We offer several container classes to decorate videos: .. container:: video-1 - .. video:: https://sphinxcontrib-video.readthedocs.io/en/latest/_images/video.mp4 + .. video:: https://interactive-examples.mdn.mozilla.net/media/cc0-videos/flower.webm .. container:: video-1 @@ -243,7 +251,7 @@ We offer several container classes to decorate videos: .. container:: video-1 - .. video:: https://sphinxcontrib-video.readthedocs.io/en/latest/_images/video.mp4 + .. video:: https://interactive-examples.mdn.mozilla.net/media/cc0-videos/flower.webm .. code-block:: ReST @@ -255,7 +263,7 @@ We offer several container classes to decorate videos: .. container:: video-2 - .. video:: https://sphinxcontrib-video.readthedocs.io/en/latest/_images/video.mp4 + .. video:: https://interactive-examples.mdn.mozilla.net/media/cc0-videos/flower.webm .. container:: video-2 @@ -264,4 +272,4 @@ We offer several container classes to decorate videos: .. container:: video-2 - .. video:: https://sphinxcontrib-video.readthedocs.io/en/latest/_images/video.mp4 + .. video:: https://interactive-examples.mdn.mozilla.net/media/cc0-videos/flower.webm