python-sphinx - 转义 reStructuredText Sphinx 中的特殊字符

Question

对于我的文档，我想要转义特殊字符。

例子 ：

.. code-block:: terminal

    $ php bin/console test:user

    Press <return> for continue

对于 Sphinx，它是一个外部 URL <return>，我想转义它。

截屏 ：

标签： python-sphinxrestructuredtext

Answer 1

参见转义机制：

后跟任何字符（非 URI 上下文中的空白字符除外）的反斜杠会转义该字符。转义字符表示字符本身，并且无法在任何标记解释中发挥作用。从输出中删除反斜杠。

要回答您的问题，您可以使用各种标记技术。

转义左括号和右括号。

Press \<return\> for continue

使用内联文字标记。

Press ``<return>`` for continue

对角色使用语义标记kbd：

Press :kbd:`<return>` for continue

IMO，最后一个选项最适合这种情况。第一个选项是最不合适的。