DOC: Document videos (#494)

executablebooks · Feb 20, 2022 · 4b0ab4b · 4b0ab4b
1 parent 056d66e
commit 4b0ab4b
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 0 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -21,6 +21,7 @@
     "sphinx.ext.autodoc",
     "sphinx.ext.intersphinx",
     "sphinx.ext.viewcode",
+    "sphinxcontrib.youtube",
     "sphinx_copybutton",
     "sphinx_design",
     "sphinx_tabs.tabs",

diff --git a/docs/reference/extensions.md b/docs/reference/extensions.md
@@ -101,3 +101,10 @@ This toggle is in the margin!
 
       Oranges are orange.
 ````
+
+## `sphinxcontrib.youtube` for videos
+
+[`sphinxcontrib.youtube`](https://github.com/sphinx-contrib/youtube) makes it possible to easily embed videos in your documentation.
+
+```{youtube} 2Z7wDaYt53Y
+```
diff --git a/pyproject.toml b/pyproject.toml
@@ -65,6 +65,7 @@ doc = [
     "sphinx-togglebutton>=0.2.1",
     "sphinx-thebe>=0.1.1",
     "sphinxcontrib-bibtex~=2.2",
+    "sphinxcontrib-youtube",
     "sphinxext-opengraph",
 ]
 test = [