Skip to content

Commit

Permalink
docs: update video url
Browse files Browse the repository at this point in the history
  • Loading branch information
lepture committed Aug 26, 2024
1 parent a283078 commit cc2c08d
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 12 deletions.
3 changes: 3 additions & 0 deletions docs/contributing/roadmap.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
--------------
Expand Down
32 changes: 20 additions & 12 deletions docs/writing/media.rst
Original file line number Diff line number Diff line change
Expand Up @@ -183,11 +183,13 @@ Videos

There is no built-in ``video`` directive for Sphinx. But you can use these extensions instead:

- `sphinxcontrib-video <https://sphinxcontrib-video.readthedocs.io/>`_
- `sphinxcontrib-youtube <https://sphinxcontrib-youtube.readthedocs.io/>`_
.. _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:

Expand All @@ -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:

Expand Down Expand Up @@ -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

Expand All @@ -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
Expand All @@ -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

Expand All @@ -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

0 comments on commit cc2c08d

Please sign in to comment.