Sphinx-Gallery#

一个 Sphinx 扩展，它可以从任何一组 Python 脚本构建一个 HTML 示例画廊。查看文档以获取有关如何使用它的介绍以及更多内容…

功能#

🚀 创建示例画廊通过运行纯 Python 示例脚本，同时捕获输出 + 图形，将其渲染到 Sphinx 将其构建到您的文档中的 reST 文件中
📝 在您的示例 Python 文件中嵌入 reST，允许您将类似叙述的内容与在您的文档中生成图表的代码交织在一起。Sphinx-Gallery 还会为您的每个示例页面自动生成一个 Jupyter Notebook。
📋 为 API 文档添加迷你画廊。Sphinx-Gallery 可以生成迷你画廊，列出使用特定函数/方法/等的示例。
🔗 向您的示例添加 intersphinx 链接。Sphinx-Gallery 可以自动为您的示例中使用的函数/方法/类添加指向 API 文档的链接（对于使用 intersphinx 的任何 Python 模块）。
🗒️ 管理多个画廊以创建和嵌入多个示例文件夹的画廊。

您可以通过 pip 进行直接安装，方法是

$ pip install sphinx-gallery

提示

Sphinx-Gallery 还支持从 Matplotlib 和基于 Matplotlib 的包（如 Seaborn）中抓取图像。我们建议安装系统 optipng 二进制文件以减少生成的 PNG 文件的大小。

如果您想引用 Sphinx-Gallery，您可以使用我们的 Zenodo 存款。