如何在sphinx中启用数学?

时间:2011-12-05 12:48:26

标签: python math latex python-sphinx

我正在使用带有sphinx扩展名的pngmath来记录具有大量数学表达式的代码。在*.rst文件中执行此操作正常。

a \times b变为:


works


但是,如果我在*.py文件中尝试相同的内容,例如在模块文档中如此:

"""
a \times b
"""

我最终得到了


does not work


此外,amsmath功能似乎也无效 我需要做什么,在我的*.py文件中也有数学公式?

1 个答案:

答案 0 :(得分:7)

尝试在文档字符串之前加上小写“r” - 就像这样:

def multiply(a,b):
    r"""
    returns a \times b
    """
    return a*b

之前我从未见过文档字符串的原始文字字符串,但这会使你的\ t不被解释为<TAB>字符。