是否可以在Python中将图片嵌入到docstring中？

是否可以在Python中将图片嵌入到docstring中

我在某处看到了

docpicture

关键字，但在上面找不到doc。它是否稳定

图片应该在哪里

更新

我试过狮身人面像符号，但我的PyCharm显示出来了

i、 它看到这里应该是一个图像，但没有看到图像文件

---

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

这取决于处理文档字符串时使用的工具。查看工具文档，了解如何嵌入图像

例如，如果您使用的是Sphinx，则可以使用

image

指令，如中所述：

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

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

---

这取决于处理docstring时使用的工具。查看工具文档，了解如何嵌入图像

例如，如果您使用的是Sphinx，则可以使用

image

指令，如中所述：

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

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

---

我使用的是pycharm，根本不生成文档。我想在代码探索时看到它。最常用的工具是什么？我相信PyCharm支持Sphinx docstring语法。虽然我发现PyCharm理解狮身人面像符号，但我不确定它是否能呈现图像。因此，问题的剩余部分是图像文件应该位于何处？我使用的是pycharm，根本不生成文档。我想在代码探索时看到它。最常用的工具是什么？我相信PyCharm支持Sphinx docstring语法。虽然我发现PyCharm理解狮身人面像符号，但我不确定它是否能呈现图像。因此，问题的剩余部分是图像文件应位于何处？将图像放置在适当位置后，您是否能够在pycharm中看到图像？对于我来说，仅当我在中输入完整路径时才会渲染图像”file:///Users/xyz/rotation_matrix.png“格式。相对路径不适用于我。将图像放置在适当位置后，您是否能够在pycharm中看到图像？对于我来说，仅当我在中输入完整路径时才会渲染图像”file:///Users/xyz/rotation_matrix.png“格式。相对路径对我不起作用。

.. image:: example.png