diff --git a/docs/conf.py b/docs/conf.py index b155544..c2e7693 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -29,6 +29,7 @@ "sphinx.ext.intersphinx", "sphinx_code_tabs", "sphinxcontrib.typer", + "sphinxcontrib.video", ] # exclude_patterns = [] diff --git a/docs/source/basics/local_link.gif b/docs/source/basics/local_link.gif deleted file mode 100644 index 3ad9196..0000000 Binary files a/docs/source/basics/local_link.gif and /dev/null differ diff --git a/docs/source/basics/local_link.mp4 b/docs/source/basics/local_link.mp4 new file mode 100644 index 0000000..13d8135 Binary files /dev/null and b/docs/source/basics/local_link.mp4 differ diff --git a/docs/source/basics/quickstart.rst b/docs/source/basics/quickstart.rst index 34e168a..54f0740 100644 --- a/docs/source/basics/quickstart.rst +++ b/docs/source/basics/quickstart.rst @@ -1,7 +1,9 @@ Quick Start =========== -.. image:: local_link.gif +.. video:: local_link.mp4 + :alt: local link + :align: center Three steps to quickly run ``CodeLinks`` to generate links to your source code: @@ -33,7 +35,6 @@ One-line comment :caption: dummy_src.cpp :language: cpp - Directive --------- @@ -41,8 +42,6 @@ Directive :caption: index.rst :language: rst - - Example ------- diff --git a/pyproject.toml b/pyproject.toml index 35c0b3b..4c28a13 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -60,6 +60,7 @@ dev-dependencies = [ "toml>=0.10.2", "sphinx-code-tabs>=0.5.5", "sphinxcontrib-typer>=0.5.1", + "sphinxcontrib-video>=0.4.1", ] [project.scripts]