0

私はスフィンクスが初めてです。私が直面している状況は、私が複雑な関数を持っているということです.sphinxのドキュメントでは、関数の直接的な使用例を示したいと思います.

def myComplicatedFunction(status):
    """Here I have a brief description

    :param status: explanation

    :returns: explanation
    """
    <<< code >>>

    return statstics

sphinx-part のどこかに、入力例と出力例を示す Python コードをいくつか含めたいと思います。しかし、ドキュメントが示唆しているように、私が何をしても（``または::を使用します）、構文の強調表示は行われません。単純なテキストとして含まれているため、読みにくくなっています。

sphinxにpythonコード例を含めるにはどうすればよいですか?

4

2 に答える 2

2

Pythonインタラクティブセッションをシミュレートします。で始まるブロックは>>>、Pythonソースコードとして自動的に扱われます。

def myComplicatedFunction(status):
    """Here I have a brief description

    :param status: explanation

    :returns: explanation

    >>> myComplicatedFunction('status value')
    {'foo': 2, 'bar': -400}

    """
    # Code

    return statistics
于 2012-09-24T12:13:09.107 に答える
0 
.. code-block:: language
      def foo()....

Pythonで動作しますが、pygmentsがインストールされていることを確認してください。

somethingconf.py 構成ファイルで、次の 2 つのステートメントは興味深いものです。

pygments_style = 'sphinx'

出力に応じて、次のように記述します

options['add_syntax_highlighting'] = True
于 2012-09-24T12:25:49.823 に答える