在文档字符串公式中使用'\ displaymath'指令

Question

[我正在使用Sphinx文档包来记录我正在使用的小型Python工具包，我想通过以Python文档字符串中的LaTeX格式列出它们来描述各个模块实现的数学公式。

例如，使用reStructuredText的:math:或.. math::指令很容易做到这一点，例如：

.. math::
   \\displaymath \\sum_{i=1}^{\\infty} x_{i}

但是\\displaymath指令在Python文档字符串中只是突出显示为红色文本。当在.rst文件（例如index.rst）中使用时，此功能可以按预期工作，并且求和的子脚本和上标直接在求和符号的下方和上方。

难道这根本不支持文档字符串，或者我做错了事还是没有做我需要做的事？

Answer 1

[在Sphinx中不需要\displaymath，并且\sum和\infty不需要其他转义反斜杠。

下面的示例函数在用.. autofunction::调用时，在html和乳胶输出中都能正常显示。

def test_func(x):
    """This function will try to calculate:

    .. math::
        \sum_{i=1}^{\\infty} x_{i}

    good luck!
    """
    pass

您必须使用.. math::指令，因为内联数学（:math:）不起作用。