如何在ReST中处理两个破折号

Question

我正在使用Sphinx来记录用Python编写的命令行实用程序.我希望能够记录命令行选项,--region如下所示:

**--region**  <region_name>

在ReST中然后使用Sphinx为我生成我的HTML和手册页.

这在生成手册页时效果很好,但在生成的HTML中,--变为-不正确的.我发现如果我将源ReST文档更改为如下所示:

**---region**  <region_name>

HTML生成正确,但现在我的手册页---而不是--.也不正确.

我试图用反斜杠字符(例如\-\-)转义破折号,但这没有效果.

任何帮助将非常感激.

Answer 1

这是 Sphinx 中默认启用的配置选项：该html_use_smartypants选项 ( http://sphinx-doc.org/config.html?highlight=dash#confval-html_use_smartypants )。

\n\n

如果关闭该选项，则如果需要短破折号，则必须使用 Unicode 字符 \'\xe2\x80\x93\'。

\n