python - 在 sphinx 的头函数声明部分中包含 python 源代码

Question

我是狮身人面像的新手。我面临的情况是我有一个复杂的函数，并且在我想展示的 sphinx 文档中，直接使用该函数的一些示例。

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

    :param status: explanation

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

    return statstics

在狮身人面像部分的某处，我想包含一些显示示例输入和示例输出的 python 代码。但是无论我做什么（使用``或::），因为文档表明它没有得到语法高亮显示。它只是作为简单的文本包含在内，这使得阅读变得困难。

我应该如何在 sphinx 中包含 python 代码示例？

Answer 1

模拟 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

Answer 2

.. code-block:: language
      def foo()....

适用于 python，但请确保您已安装 pygments。

在 somethingconf.py 配置文件中，这两个语句很有趣：

pygments_style = 'sphinx'

并根据输出写出类似的东西

options['add_syntax_highlighting'] = True