如何在 Sphinx 中启用数学功能？

Question

我正在使用sphinx，并配合pngmath这个扩展，来记录我的代码，其中包含很多数学表达式。在一个*.rst文件中，这样做效果很好。

比如，a \times b会变成：

---

---

但是，如果我试着在一个*.py文件中做同样的事情，比如在模块文档中这样写：

"""
a \times b
"""

结果却是：

---

---

而且，amsmath的功能似乎也都无法使用。
我需要做些什么，才能在我的*.py文档中也显示数学公式呢？

Answer 1

试着在你的文档字符串前加一个小写的'r'，像这样：

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

我之前从没见过文档字符串用原始字符串的写法，但这样做可以防止你的\t被当作一个<TAB>字符来解释。