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

Question

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

似乎通过命令：文档字符串中的“.. image::”，它阻止了拿破仑预处理器的预解释，文档字符串由标准的 sphinx 解释器解释。

"""Func

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

   Returns:
       string: description 3.

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

我的图片显示正确，但参数和 return 值未正确解释，它们看起来像纯文本。

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

"""Func

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

   Returns:
       string: description 3.
"""

有人有解决办法吗？

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

Answer 1

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

它可以看起来像这样：

"""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
"""

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

Insert image in sphinx using napoleon pre-processor

python

python-sphinx

sphinx-napoleon