是否可以在Python中将图片嵌入到文档字符串中？

Question

是否可以在Python中将图片嵌入到文档字符串中？

我在某处看到了docpicture关键字，但找不到关于它的文档。它是否被稳定化了？

图片应放在哪里？

UPDATE

我试图狮身人面像的符号，但我PyCharm显示

即它认为它应该是一个形象在这里，但没有看到的图像文件。

如果使用狮身人面像，我会放在哪里？

Answer 1

这取决于你用什么工具来处理你的文档字符串。检查你的工具的文档，找出如何嵌入图像。

例如，如果使用的是斯芬克斯，则可以使用image指令，如在this StackOverflow answer描述：

.. image:: example.png 

关于图像的位置，documentation状态：

当在Sphinx中使用，文件名必须是相对于源文件，或绝对的，这意味着它们是相对于顶级源目录。例如，sketch/spam.rst文件可以将image images/spam.png称为../images/spam.png或/images/spam.png。