Verwenden von '\ displaymath' Direktiven in Docstrings Formeln

Question

Ich verwende das Sphinx-Dokumentationspaket, um ein kleines Python-Toolkit zu dokumentieren, an dem ich arbeite, und ich möchte die mathematischen Formeln der verschiedenen Module beschreiben, indem ich sie in LaTeX auflistet Format in den Python-Docstrings.

Es ist ziemlich einfach, dies mit :math: oder .. math:: Richtlinien für reStructuredText zu erreichen, zum Beispiel:

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

aber die \\displaymath Direktive werden nur als roter Text hervorgehoben, wenn in einem Python docstring. Bei Verwendung in einer .rst Datei (z. B. index.rst) funktioniert dies wie erwartet, und die Sub- und Super-Skripte für die Summierung liegen direkt unterhalb und oberhalb des Summensymbols.

Wird dies nicht einfach für Docstrings unterstützt, oder mache ich etwas falsch oder mache ich nicht etwas, was ich tun muss?

Answer 1

Sie benötigen keine \displaymath in Sphinx und keine zusätzlichen Escaping Backslashes für \sum und \infty.

Die folgende Beispiel-Funktion macht in HTML und Latex Ausgang gut, wenn mit .. autofunction:: genannt:

def test_func(x): 
    """This function will try to calculate: 

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

    good luck! 
    """ 
    pass 

Sie haben die .. math:: Richtlinie als Inline-Mathematik verwenden (:math:) funktioniert nicht.