在docstrings公式中使用'\ displaymath'指令

Question

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

使用resstructuredText的:math:或.. math::指令很容易实现此目的，例如：

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

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

这对于文档字符串是不是支持，还是我做错了什么或者没有做我需要做的事情？

Answer 1

您在Sphinx中不需要\displaymath，并且\sum和\infty没有额外的转义反斜杠。

使用.. autofunction::调用时，以下示例函数在html和latex输出中呈现正常：

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

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

    good luck!
    """
    pass

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