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

Question

我正在使用Sphinx文檔包記錄我正在處理的一個小型Python工具包，並且我想描述各種模塊通過將它們列在LaTeX中來實現的數學公式Python文檔中的格式。

這是很容易與:math:或.. math::指令的新結構化，例如，以實現這一目標：

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

但\\displaymath指令只是突出顯示爲紅色文本在Python文檔字符串時。當用於.rst文件（例如index.rst）時，其工作方式與預期相符，並且用於求和的子腳本和超級腳本直接位於求和符號的下方和上方。

這是不是支持docstrings，或者我做錯了什麼或不做我需要做的事情？

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:）不起作用。