terminal - 如何在 Sphinx 中显示终端/shell 代码片段？

Question

使用 Sphinx，我知道您可以通过以下方式显示代码片段：

.. code-block:: ruby.
  ${your ruby code goes here} 

如何显示与任何语言无关的终端或 shell 命令的代码片段？我不在乎它们是否在语法上没有正确突出显示，我只是希望它们在文档中显示为一段代码而不是普通文本。

例子

$ ls -lsa . 
$ make file

Answer 1

.. code-block:: console

用于交互式会话。Bash 或 sh 对我不起作用。

（来自http://build-me-the-docs-please.readthedocs.org/en/latest/Using_Sphinx/ShowingCodeExamplesInSphinx.html#pygments-lexers）

Answer 2

对于 Linux 控制台命令，您可以使用bash或sh：

.. code-block:: bash

   $ ls -lsa .
   $ make file

突出显示可能不会一直正常工作，但至少你给了它一个机会。

如果您使用带有双冒号的@Bonlenfum 方式，您还可以在文件开头设置默认突出显示：

.. highlight:: sh

Answer 3

您可以将要编写为代码的文本缩进，并在其前面加一个双冒号。例如：

Some body text explaining what's coming up::

    ls -lsa .
    make file

或者事实证明，您可以在没有任何文本的情况下离开，只需使用双冒号。在第一种情况下，渲染一个冒号，而对于这种情况，只渲染代码。

::
    mkdir test
    cd !$  

然后命令将以固定宽度的字体出现，并且根据您选择的样式表，也会突出显示（默认情况下，以绿色背景突出显示）。

您还可以使用反引号进行内联突出显示，例如`ls -lsa .`.