我编写了一个rst文件,并计划显示以下内容:
命令-abc --efg
当两个破折号放在一起时,我尝试了几种方法来逃脱破折号,但是我无法在编译文档中得到所需的内容。这是我尝试过的一些方法:
command -abc --efg
command -abc \--efg
command -abc -\-efg
command -abc \-\-efg
command -abc \--\--efg
有什么建议么?
根据您的Sphinx版本,您将具有html_use_smartypants=True
(Sphinx <1.6.6)或smartquotes=True
(Sphinx≥1.6.6)。如果您在conf.py
或调用时省略了设置sphinx-build
,则默认值True
将生效,将双破折号“ --
”转换为印刷的破折号“ –”。有关所有转换,请参见Docutils的智能报价,说明。
您可以在双破折号中转义每个字符,但这是丑陋的标记,并且显示内容与内联文本无法区分。
command -abc \\-\\-efg
要显示内联命令,请用双勾号将其包围。显示是可区分的命令。
Enter the command ``command -abc --efg`` to do stuff.
要以单独的文本块显示命令,请使用.. code-block::
。
.. code-block:: bash
command -abc --efg
呈现以上示例的显示:
本文收集自互联网,转载请注明来源。
如有侵权,请联系 [email protected] 删除。
我来说两句