Как включить математику в сфинксе?

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> символ.