Sphinx-Gallery 工具

将 Python 脚本转换为 Jupyter Notebooks

Sphinx Gallery 将其 Python 源代码公开为可执行脚本，用于转换为 Jupyter notebook。要使用此实用程序，只需调用脚本并提供 Python 源文件作为参数。

$ python -m sphinx_gallery_py2jupyter python_script.py

将 Sphinx-Gallery 嵌入到您的文档脚本扩展中

如果您想将 Sphinx-Gallery 嵌入到您的项目中，而不是将其作为依赖项添加，您可以在 Sphinx 扩展文件夹中调用我们的嵌入脚本。

# Script to do a local install of sphinx-gallery
rm -rf tmp sphinx_gallery

easy_install -Zeab tmp sphinx-gallery

cp -vru tmp/sphinx-gallery/sphinx_gallery/ .

echo "Remember to add sphinx_gallery to your version control"
echo "Use in case of git:"
echo "$ git add sphinx_gallery"

这将直接从 PyPI 下载我们最新发布的代码并将其保存到当前文件夹。这是 Sphinx-Gallery 模块的简化版本，可用于集成到您的项目中。您也应该将其添加到您的版本控制系统中。

Minigallery 指令

Sphinx-Gallery 提供 minigallery 指令，使您可以轻松地将缩减版的画廊添加到您的文档中。有关详细信息，请参见 添加迷你画廊。