如何在sphinx中启用数学？

Question

我正在使用sphinx和pngmath扩展来记录我的代码,它有很多数学表达式.在*.rst文件中执行此操作正常.

a \times b 变为:

---

---

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

"""
a \times b
"""

我结束了

---

---

此外,任何amsmath功能似乎都不起作用.
我需要做什么,在我的*.py文档中也有数学公式？

Answer 1

尝试在docstring之前放置一个小写的'r' - 像这样:

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

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