python 文档字符串中的标签
label in python docstring
我正在使用 sphinx autodoc 将我的文档字符串翻译成一个不错的文档页面。在文档字符串中，我通过使用 sphinx napoleon 扩展来遵循 numpy 的文档字符串指南。我想知道以下问题：如果我有一个像
这样的方程式
"""
This is a very important equation which is used in the code
.. math::
a+b=c
:label: important_eq
"""
autodoc 无法识别 :label:。我的格式有误还是 autodoc/mathjax/napoleon 无法处理方程式中的标签？
注意空格和缩进。这有效：
.. math::
:label: important_eq
a+b=c
这也行（当数学内容只有一行文本时，可以作为指令参数给出）：
.. math:: a+b=c
:label: important_eq
我正在使用 sphinx autodoc 将我的文档字符串翻译成一个不错的文档页面。在文档字符串中，我通过使用 sphinx napoleon 扩展来遵循 numpy 的文档字符串指南。我想知道以下问题：如果我有一个像
这样的方程式"""
This is a very important equation which is used in the code
.. math::
a+b=c
:label: important_eq
"""
autodoc 无法识别 :label:。我的格式有误还是 autodoc/mathjax/napoleon 无法处理方程式中的标签？
注意空格和缩进。这有效：
.. math::
:label: important_eq
a+b=c
这也行（当数学内容只有一行文本时，可以作为指令参数给出）：
.. math:: a+b=c
:label: important_eq