Sphinx文档嵌入视频

和 Sphinx文档嵌入YouTube视频 类似， sphinxcontrib-video 提供了将视屏嵌入 Sphinx文档 的能力。

  • 安装 sphinxcontrib-video 插件:

    pip install sphinxcontrib-video

  • 然后修改 source/conf.py :

source/conf.py 增加 sphinxcontrib.video 扩展配置
...
extensions = [
        'sphinx.ext.graphviz',
        'sphinxnotes.strike',
        'sphinxcontrib.newsfeed',
        'sphinxcontrib.youtube',
        'sphinxcontrib.video'
]
...

  • 然后在文档中直接使用如下代码:

    .. video:: ../../../_static/devops/docs/sphinx_doc/ssngsjzr.mp4

就可以看到我使用 yt-dlp 从YoutTube下载的 《杀死那个石家庄人》--万能青年旅店 影视混剪MV (我选择了一个小规格mp4作为演示， 墙裂推荐 观看YouTube原高清视频 《杀死那个石家庄人》-- 万能青年旅店 影视混剪MV )

「杀死那个石家庄人」

备注

我验证了YouTube下载的 .3gp 视频( VCODEC 是 mp4v.20.3 )，在嵌入到Sphinx文档中只有声音播放没有视频图像

参考