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

Question

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

:math:使用 reStructuredText 的or指令很容易实现这一点.. math::，例如：

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

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

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

Answer 1

您不需要\displaymath在 Sphinx 中也不需要额外的转义反斜杠\sum和\infty.

以下示例函数在使用 调用时在 html 和 Latex 输出中都呈现良好.. autofunction::：

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

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

    good luck!
    """
    pass

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