python-sphinx:如何显示linux命令代码片段

Question

使用sphinx,我知道你可以通过以下方式显示一段python代码片段或ruby代码片段:

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

如何显示linux命令的代码片段或仅显示与任何语言无关的某些控制台命令？我不在乎它们是否在语法上没有正确突出显示,我只是希望它们在doc中显示为除普通文本之外的一段代码.例如.

ls -lsa . 
make file

Answer 1

.. code-block:: console

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

Answer 2

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

.. code-block:: bash

   $ ls -lsa .
   $ make file

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

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

.. highlight:: sh

在这种情况下，您应该更喜欢“console”而不是“bash”，如 Marco Mariani 的回答所示。`bash` 可能会误解控制台特定的语法，例如行开头的 $ / # (2认同)

Answer 3

您可以将要编写的文本缩进为代码,并在其前面加上双冒号.例如:

Some body text explaining what's coming up::

    ls -lsa .
    make file

或者事实证明,你可以在没有任何文字的情况下离开,只使用双冒号.在第一种情况下,渲染一个冒号,而在这种情况下,只渲染代码.

::
    mkdir test
    cd !$

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

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