Merge pull request #41 from plone/add-sphinxcontrib-youtube-extn

Add support for sphinxcontrib-youtube
plone · Nov 18, 2024 · ef23dac · ef23dac
2 parents 0652660 + 2441c4e
commit ef23dac
Show file tree

Hide file tree

Showing 6 changed files with 14 additions and 1 deletion.
diff --git a/docs/conf.py b/docs/conf.py
@@ -74,6 +74,7 @@
     "sphinxcontrib.httpexample",  # plone.restapi
     "sphinxcontrib.mermaid",
     "sphinxcontrib.video",
+    "sphinxcontrib.youtube",
     "sphinxext.opengraph",
 ]
 

diff --git a/docs/reference/extensions.md b/docs/reference/extensions.md
@@ -54,4 +54,5 @@ These extensions are built in and can be activated by respective entries in the
     It's used by Plone's {doc}`plone:plone.restapi/docs/source/index`.
 -   [`sphinxcontrib.mermaid`](https://pypi.org/project/sphinxcontrib-mermaid/) allows you to embed [Mermaid](https://mermaid.js.org/) graphs in your documents, including general flowcharts, sequence diagrams, and Gantt charts.
 -   [`sphinxcontrib.video`](https://pypi.org/project/sphinxcontrib-video/) allows you to embed local videos as defined by the HTML5 standard.
+-   [`sphinxcontrib.youtube`](https://pypi.org/project/sphinxcontrib-video/) allows you to embed remotely hosted videos from [YouTube](https://www.youtube.com/), [Vimeo](https://vimeo.com/), or [PeerTube](https://joinpeertube.org/).
 -   [`sphinxext.opengraph`](https://pypi.org/project/sphinxext-opengraph/) generates [OpenGraph metadata](https://ogp.me/).
diff --git a/news/41.feature b/news/41.feature
@@ -0,0 +1 @@
+Add support for sphinxcontrib-youtube. @stevepiercy
diff --git a/pyproject.toml b/pyproject.toml
@@ -57,6 +57,7 @@ docs = [
   "sphinxcontrib.httpdomain",
   "sphinxcontrib.httpexample",
   "sphinxcontrib-video",
+  "sphinxcontrib-youtube",
   "sphinxext-opengraph",
 
 #  Commented from Sphinx Book Theme.

diff --git a/requirements-dev.txt b/requirements-dev.txt
@@ -139,6 +139,7 @@ requests==2.32.3
     #   pyroma
     #   requests-toolbelt
     #   sphinx
+    #   sphinxcontrib-youtube
     #   twine
     #   zest-releaser
 requests-toolbelt==1.0.0
@@ -183,6 +184,7 @@ sphinx==7.4.7
     #   sphinxcontrib-httpexample
     #   sphinxcontrib-mermaid
     #   sphinxcontrib-video
+    #   sphinxcontrib-youtube
     #   sphinxext-opengraph
 sphinx-autobuild==2024.10.3
     # via
@@ -228,6 +230,8 @@ sphinxcontrib-serializinghtml==2.0.0
     # via sphinx
 sphinxcontrib-video==0.3.1
     # via plone-sphinx-theme (pyproject.toml)
+sphinxcontrib-youtube==1.4.1
+    # via plone-sphinx-theme (pyproject.toml)
 sphinxext-opengraph==0.9.1
     # via plone-sphinx-theme (pyproject.toml)
 starlette==0.41.2

diff --git a/requirements-docs.txt b/requirements-docs.txt
@@ -72,7 +72,9 @@ pyyaml==6.0.2
     #   myst-parser
     #   sphinxcontrib-mermaid
 requests==2.32.3
-    # via sphinx
+    # via
+    #   sphinx
+    #   sphinxcontrib-youtube
 six==1.16.0
     # via
     #   astunparse
@@ -100,6 +102,7 @@ sphinx==7.4.7
     #   sphinxcontrib-httpexample
     #   sphinxcontrib-mermaid
     #   sphinxcontrib-video
+    #   sphinxcontrib-youtube
     #   sphinxext-opengraph
 sphinx-autobuild==2024.10.3
     # via plone-sphinx-theme (pyproject.toml)
@@ -141,6 +144,8 @@ sphinxcontrib-serializinghtml==2.0.0
     # via sphinx
 sphinxcontrib-video==0.3.1
     # via plone-sphinx-theme (pyproject.toml)
+sphinxcontrib-youtube==1.4.1
+    # via plone-sphinx-theme (pyproject.toml)
 sphinxext-opengraph==0.9.1
     # via plone-sphinx-theme (pyproject.toml)
 starlette==0.41.2
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		Add support for sphinxcontrib-youtube. @stevepiercy