Sphinx-Gallery¶
A Sphinx extension that builds an HTML gallery of examples from any set of Python scripts.
安装:
$ pip install sphinx-gallery
form GPT¶
Sphinx-Gallery 是 Sphinx 文档生成工具的一个扩展，用于在文档中集成和展示代码示例，并将这些代码示例的运行结果嵌入到生成的文档中。以下是 Sphinx-Gallery 的主要作用：
自动生成代码示例： Sphinx-Gallery 允许开发者在文档中嵌入代码示例，并能够自动从代码文件中提取这些示例。
自动运行代码： 该扩展可以自动运行嵌入的代码，并捕获运行结果，包括输出、图形、图像等。
生成图形和图像： 如果代码示例生成图形或图像，Sphinx-Gallery 能够捕获这些图形和图像，并将其嵌入到生成的文档中。
生成交互式的 HTML 输出： 对于包含交互式绘图或演示的示例，Sphinx-Gallery 可以生成具有交互性的 HTML 页面，使用户能够与示例进行互动。
提高文档可读性： 通过在文档中包含代码示例，开发者可以提高文档的可读性和可理解性，同时确保文档中的示例与实际代码保持同步。
支持多种代码格式： Sphinx-Gallery 支持多种代码格式，包括 Python 脚本、Jupyter 笔记本等，使得开发者能够更灵活地展示和解释代码。
总的来说，Sphinx-Gallery 通过自动化的方式，将代码示例与文档集成，提高了文档的交互性、可视化效果，同时减少了手动维护示例和运行结果的工作量。这对于编写清晰、详细的文档并与代码保持同步非常有帮助。