在rst文件中显示两个破折号

Question

我写了一个rst文件并计划显示以下内容：

命令-abc --efg

当两个破折号在一起时，我尝试了几种方法来逃脱破折号，但是我无法在编译文档中得到所需的内容。这是我尝试过的一些事情：

command -abc --efg
command -abc \--efg
command -abc -\-efg
command -abc \-\-efg
command -abc \--\--efg

有什么建议吗？

Answer 1

根据您的Sphinx版本，您有html_use_smartypants=True（Sphinx <1.6.6）或smartquotes=True（Sphinx≥1.6.6）。如果您省略了conf.py的设置或调用sphinx-build时的设置，则True的默认值将生效，将双破折号“ --”转换为印刷短划线“ –”。有关所有转化，请参见Smart Quotes for Docutils, Description。

您可以将双破折号中的每个字符转义，但这是丑陋的标记，并且显示内容与嵌入式文本无法区分。

command -abc \\-\\-efg

要内联显示命令，请在命令中加上两个勾号。显示是可区分的命令。

Enter the command ``command -abc --efg`` to do stuff.

要在单独的文本框中显示命令，请使用.. code-block::。

.. code-block:: bash

    command -abc --efg

以上示例的呈现显示：