文章/答案/技术大牛

发布

问python docstring中的标签
EN

Stack Overflow用户

提问于 2017-10-03 13:09:42

回答 1查看 344关注 0票数 1

我正在使用斯芬克斯自动文档将我的docstring转换成一个很好的文档页面。在docstring中，我使用狮身人面像拿破仑扩展来遵循numpy的docstring准则。我想知道以下几点:如果我有一个方程，比如

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

.. math::

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

自动文档不识别:label:。我是有错误的格式，还是不能用自动文档/ mathjax /拿破仑来处理等式中的标签？

回答已采纳

发布于 2017-10-03 15:04:49

注意空格和缩进。这样做是可行的：

.. math::
   :label: important_eq

   a+b=c

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

.. math:: a+b=c
   :label: important_eq

票数 1

页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持

原文链接：

https://stackoverflow.com/questions/46545401

复制

相似问题

问python docstring中的标签EN