Skip to content

Commit 78dd19d

Browse files
committed
Video: Add Vimeo example, and refer to oEmbed page
1 parent cceddc9 commit 78dd19d

File tree

2 files changed

+18
-19
lines changed

2 files changed

+18
-19
lines changed

docs/myst/video.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Videos
22

33
Videos, for example from YouTube or Vimeo, can be embedded using inline
4-
HTML, [sphinxcontrib-youtube], or [oembedpy].
4+
HTML, [sphinxcontrib-youtube], or [oEmbedPy].
55

66
## Inline HTML
77

@@ -12,11 +12,16 @@ into the Markdown file. Voilà.
1212

1313
## sphinxcontrib-youtube
1414

15-
This uses the `youtube` directive provided by `sphinxcontrib-youtube`.
15+
This uses the `youtube` and `vimeo` directives provided by `sphinxcontrib-youtube`.
1616

17+
:::{rubric} YouTube
18+
:::
1719
:::{youtube} YE7VzlLtp-4
18-
:width: 480
19-
:height: 320
20+
:::
21+
22+
:::{rubric} Vimeo
23+
:::
24+
:::{vimeo} 1084537
2025
:::
2126

2227
## oembedpy
@@ -29,13 +34,9 @@ This uses the `oembed` directive provided by `oembedpy`.
2934
:::
3035

3136
:::{tip}
32-
[oEmbedPy], as the name suggests, can render [oEmbed] information provided
33-
by any HTML page, for example Bluesky, Reddit, Twitter/X, and many more.
34-
Registered oEmbed providers can be explored per [providers.json].
37+
See {ref}`oembed-md` to learn about all capabilities of the `oembed` directive.
3538
:::
3639

3740

38-
[oEmbed]: https://oembed.com/
39-
[oembedpy]: https://oembedpy.readthedocs.io/
40-
[providers.json]: https://oembed.com/providers.json
41+
[oEmbedPy]: https://oembedpy.readthedocs.io/
4142
[sphinxcontrib-youtube]: https://sphinxcontrib-youtube.readthedocs.io/

docs/rst/video.rst

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,13 @@ into the Markdown file. Voilà.
1818
sphinxcontrib-youtube
1919
=====================
2020

21-
This uses the ``youtube`` directive provided by ``sphinxcontrib-youtube``.
21+
This uses the ``youtube`` and ``vimeo`` directives provided by ``sphinxcontrib-youtube``.
2222

23+
.. rubric:: YouTube
2324
.. youtube:: YE7VzlLtp-4
24-
:width: 480
25-
:height: 320
25+
26+
.. rubric:: Vimeo
27+
.. vimeo:: 1084537
2628

2729
oembedpy
2830
========
@@ -35,12 +37,8 @@ This uses the ``oembed`` directive provided by ``oembedpy``.
3537

3638
.. tip::
3739

38-
`oEmbedPy`_, as the name suggests, can render `oEmbed`_ information provided
39-
by any HTML page, for example Bluesky, Reddit, Twitter/X, and many more.
40-
Registered oEmbed providers can be explored per `providers.json`_.
40+
See :ref:`oembed-rst` to learn about all capabilities of the ``oembed`` directive.
4141

4242

43-
.. _oEmbed: https://oembed.com/
44-
.. _oembedpy: https://oembedpy.readthedocs.io/
45-
.. _providers.json: https://oembed.com/providers.json
43+
.. _oEmbedPy: https://oembedpy.readthedocs.io/
4644
.. _sphinxcontrib-youtube: https://sphinxcontrib-youtube.readthedocs.io/

0 commit comments

Comments
 (0)