embed video

MDAnalysis · Oct 23, 2024 · 6230777 · 6230777
1 parent b4b782c
commit 6230777
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 1 deletion.
diff --git a/docs/requirements.yaml b/docs/requirements.yaml
@@ -9,6 +9,7 @@ dependencies:
 
     - sphinx
     - mdanalysis-sphinx-theme
+    - sphinxcontrib-youtube
 
     - pyyaml
     - pydantic

diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -56,6 +56,7 @@
     'sphinx.ext.napoleon',
     'sphinx.ext.intersphinx',
     'sphinx.ext.extlinks',
+    'sphinxcontrib.youtube',
 ]
 
 autosummary_generate = True

diff --git a/docs/source/making-a-kit/from-cookiecutter.rst b/docs/source/making-a-kit/from-cookiecutter.rst
@@ -7,7 +7,11 @@ Guided Example: Building an RMSF analysis Kit
 In this section, we provide a guided example for creating an MDAKit
 using the `MDAKit cookiecutter <https://cookiecutter-mdakit.readthedocs.io>`_.
 A `video walk-through <https://www.youtube.com/watch?v=viCPUHkgSxg>`_ 
-of this tutorial is available on YouTube.
+of this tutorial is available on YouTube:
+
+.. youtube:: viCPUHkgSxg
+   :align: center
+
 
 We will create a kit for RMSF analysis, replicating the functionality 
 of the `RMSF analysis class <https://docs.mdanalysis.org/stable/documentation_pages/analysis/rms.html#MDAnalysis.analysis.rms.RMSF>`_