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)

"""

::可以解決問題。