1

我正在使用 sphinx autodoc 将我的文档字符串翻译成一个不错的文档页面。在文档字符串中，我通过使用 sphinx 拿破仑扩展来遵循 numpy 的文档字符串指南。我想知道以下几点：如果我有一个等式

"""
This is a very important equation which is used in the code

.. math::

     a+b=c
   :label: important_eq
"""

自动文档无法识别:label:. 我的格式是否错误，或者 autodoc/mathjax/napoleon 无法处理方程式中的标签？

4

1 回答 1

1

注意空格和缩进。这有效：

.. math::
   :label: important_eq

   a+b=c

这也有效（当数学内容只有一行文本时，它可以作为指令参数给出）：

.. math:: a+b=c
   :label: important_eq
于 2017-10-03T15:04:49.787 回答