如何使用带有尾随空格的内联代码?

时间:2017-08-06 17:34:45

标签: whitespace python-sphinx restructuredtext

当我使用

``# ``

在我的Sphinx文档中,我收到以下警告:

WARNING: Inline literal start-string without end-string.

尝试

:samp:`# `

导致

WARNING: Inline interpreted text or phrase reference start-string without end-string.

问题似乎是尾随的空白,但我无法找到解决这个问题的方法。使用反斜杠(\)转义空白也没有帮助(对于第一个示例,警告仍然存在,对于第二个示例,生成的文档中省略了空格)。

This answer无法正常工作,因为内联代码部分将|space|解释为文字字符串。

熟悉Sphinx 1.6.2。

2 个答案:

答案 0 :(得分:2)

解决方法是使用不间断空格字符(U + 00A0)而不是常规空格(U + 0020)作为尾随空格。

有几种方法可以插入文字不间断空格字符。请参阅https://en.wikipedia.org/wiki/Non-breaking_space#Keyboard_entry_methods

答案 1 :(得分:0)

使用"literal" role __并在预期的尾随空格后加上转义空格:

:literal:`# \ `

__ https://docutils.sourceforge.io/docs/ref/rst/roles.html#literal