Python Sphinx:如何将代码嵌入到文档字符串中

Question

我如何将代码嵌入到文档字符串中，以告诉Sphinx将代码格式化为类似于Markdown中的格式(不同的背景颜色，单空格无字体(？例如，记录代码使用示例。

""" This is a module documentation
Use this module like this:
res = aFunction(something, goes, in)
print(res.avalue)
"""

Answer 1

有几种方法可以做到这一点。我认为在您的情况下最明智的方法是.. code-block::

""" This is a module documentation
Use this module like this:
.. code-block:: python
res = aFunction(something, goes, in)
print(res.avalue)
"""

请注意指令和代码块之间的空行——它必须在那里才能正确呈现代码块。

Answer 2

另一种突出显示代码的方法(请参阅mzjn在这篇文章中的评论(是在代码前一行以两个(！(冒号结尾：

""" This is a module documentation
Use this module like this::
res = aFunction(something, goes, in)
print(res.avalue)
"""

::起了作用。