diff --git a/docs/requirements.yaml b/docs/requirements.yaml index a3604287..d28ca113 100644 --- 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 index 961be42b..74fdaa61 100644 --- 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 index 03a60b6d..8d08ad67 100644 --- 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 `_. A `video walk-through `_ -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 `_