在python文档中嵌入图像

Question

我有一个python项目，我想创建文档。。。在

在本文档中，允许嵌入图像是至关重要的。另外，我不想创建单独的文件。换句话说：*.py文件将同时包含脚本和文档（嵌入了图像）。在

当然，稍后*.py将由一个工具处理，以创建降价或html报告

我查看了mkDocs和{a2}，但我不确定它们是否支持这些需求。在

有人知道如何用这些工具（或其他工具）做类似的事情吗？在

Answer 1

正如@mzjn建议的那样，您可以在python模块中编写docstring。Docstrings可能是有效的RestructedText。reStructuredText语法支持inline images。图像的给定文件名必须相对于源文件或绝对于文档根。您必须有一个单独的图像文件。在

要使用Sphinx构建文档，您将需要一组用于构建文档的structedText文件。可以使用Sphinx ^{}生成.rst源文件。在

一旦您编写了docstring，并创建了.rst源文件，并将conf.py配置为使用autodoc模块来拉入模块的docstring，那么就可以使用Sphinx及其^{} module来构建支持格式的文档，包括HTML。在

请注意，图像必须是builder输出所支持的格式。在