11

私は Sphinx ドキュメント パッケージを使用して、現在取り組んでいる小さな Python ツール キットをドキュメント化しています。さまざまなモジュールが実装する数式を、Python docstrings に LaTeX 形式でリストすることで説明したいと思います。

reStructuredText の:math:orディレクティブを使用してこれを実現するのは非常に簡単です。次に例を示します。.. math::

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

ただし、\\displaymathPython docstring では、ディレクティブは赤いテキストとして強調表示されます。.rstファイル (例: )で使用すると、index.rstこれは期待どおりに機能し、合計の下付き文字と上付き文字は合計記号のすぐ下と上にあります。

これは単純に docstring でサポートされていないのでしょうか、それとも何か間違ったことをしているのですか?

4

1 に答える 1

22

Sphinxでは必要なく\displaymath、 and の追加のエスケープ バックスラッシュも必要\sumありません\infty。

次のサンプル関数は、で呼び出されたときに、html と latex 出力の両方で適切にレンダリングされます.. autofunction::。

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

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

    good luck!
    """
    pass

インライン演算 ( ) が機能しないため、.. math::ディレクティブを使用する必要があります。:math:

于 2012-04-10T20:52:30.427 に答える