Terminal 如何在Sphinx中显示终端/外壳代码片段?

Terminal 如何在Sphinx中显示终端/外壳代码片段?,terminal,python-sphinx,Terminal,Python Sphinx,使用Sphinx,我知道您可以通过如下方式显示代码片段: .. code-block:: ruby. ${your ruby code goes here} 如何显示与任何语言都不相关的终端或shell命令的代码段?我不在乎它们是否在语法方面没有正确突出显示,我只希望它们在文档中显示为一段代码,而不是普通文本 示例 $ls-lsa。 $make文件 您可以缩进要编写为代码的文本,并在其前面加上双冒号。例如: Some body text explaining what's coming

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

.. code-block:: ruby.
  ${your ruby code goes here} 
如何显示与任何语言都不相关的终端或shell命令的代码段?我不在乎它们是否在语法方面没有正确突出显示,我只希望它们在文档中显示为一段代码,而不是普通文本

示例

$ls-lsa。
$make文件

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

Some body text explaining what's coming up::

    ls -lsa .
    make file
或者你也可以不用任何文字,只用双冒号。在第一种情况下,渲染一个冒号,而在这种情况下,只渲染代码

::
    mkdir test
    cd !$  
然后命令将以固定宽度字体显示,并且根据您选择的样式表,也将高亮显示(默认情况下,以绿色背景高亮显示)


您还可以使用反勾号内联突出显示,例如,对于Linux控制台命令,您可以使用
bash
sh

.. code-block:: bash

   $ ls -lsa .
   $ make file
突出显示可能不会一直正常工作,但至少你给了它一个机会

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

.. highlight:: sh
用于交互式会话。Bash或sh不适合我


(from)

这比
bash
sh
更可取,因为它是正在描述的控制台/终端,而不是脚本。请注意,它不能很好地处理长行。此外,这种轻量级方法是不可取的,除非它还与类似于
的解析器指令结合使用。。突出显示ReST文档开头的::console
。这样做会通知ReST解析器(例如,Sphinx)用于所有缺少显式语言的代码块的默认语言。在这种情况下,应该是
控制台
——与bashshellone系列相关联的“语言”,旨在以交互方式运行。也就是说,显式比隐式好。
.. code-block:: console