是否有可能将图片嵌入到Python的docstring中？

Question

是否有可能将图片嵌入到Python的docstring中？

我在docpicture某处看到了关键字,但找不到文档.它是否是坚定的？

图片应该放在哪里？

UPDATE

我试过Sphinx符号,但我的PyCharm显示

即它看到它应该是一个图像,但没有看到图像文件.

如果使用Sphinx我会放在哪里？

Answer 1

这取决于您用于处理文档字符串的工具.查看工具的文档以了解如何嵌入图像.

例如,如果您使用的是Sphinx,则可以使用该image指令,如此StackOverflow答案中所述:

.. image:: example.png

关于图像的位置,文档说明:

在Sphinx中使用时,给定的文件名必须相对于源文件,或者绝对意味着它们相对于顶级源目录.例如,文件sketch/spam.rst可以将图像images/spam.png称为../images/spam.png或/images/spam.png.