restructuredtext - 在第一个文件中显示两个破折号

Question

我编写了第一个文件并计划显示以下内容:

命令 -abc --efg

当两个破折号在一起时，我尝试了几种方法来转义破折号，但我无法在编译的文档中获得我想要的内容。以下是我尝试过的一些方法:

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

有什么建议吗？

Answer 1

根据您的 Sphinx 版本，您可能有 html_use_smartypants=True (狮身人面像 < 1.6.6)或 smartquotes=True (狮身人面像 ≥ 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.

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

.. code-block:: bash

    command -abc --efg

上述示例的渲染显示: