使用拿破仑预处理器在狮身人面像中插入图像答案

【问题标题】：Insert image in sphinx using napoleon pre-processor使用拿破仑预处理器在狮身人面像中插入图像
【发布时间】：2020-07-01 12:06:39
【问题描述】：

使用 sphinx 3.1.1，我想使用拿破仑预处理器插入图像。

似乎通过命令： ".. image::" 在文档字符串中，它防止使用拿破仑预处理器进行预解释，并且文档字符串由标准 sphinx 解释器解释。

"""Func

   Args:
       var1 (number): description 1.
       var2 (string): description 2.

   Returns:
       string: description 3.

.. image:: /_images/test.png
   :width: 100
"""

我的图像显示正确，但参数和返回值没有正确解释，它们看起来像纯文本。

当我删除图像命令时，我得到了预期的解释：

"""Func

   Args:
       var1 (number): description 1.
       var2 (string): description 2.

   Returns:
       string: description 3.
"""

有人有解决办法吗？

备注：我不想在 sphinx 标准 reStructuredText 中编写我的文档。

【问题讨论】：

请显示错误图片
请通过编辑您的问题显示错误消息的文本（请不要显示文本图像），以及抛出错误消息的文档字符串部分。
完成！我希望现在更清楚:)。实际上没有涉及错误，只是拿破仑预处理器停止工作。

标签： python python-sphinx sphinx-napoleon

【解决方案1】：

空格很重要。 image 指令必须与文档字符串中的其他段落对齐。

它可能看起来像这样：

"""Func

   Args:
       var1 (number): description 1.
       var2 (string): description 2.

   Returns:
       string: description 3.

   .. image:: /_images/test.png
      :width: 100
"""

或者像这样：

"""
Func
 
Args:
    var1 (number): description 1.
    var2 (string): description 2.
 
Returns:
    string: description 3.
 
.. image:: /_images/test.png
   :width: 100
"""

【讨论】：

非常感谢，我尝试了所有带有空格的方法，但我错过了最合乎逻辑的解决方案。太好了！