我正在使用 Sphinx 来记录用 Python 编写的命令行实用程序。我希望能够记录命令行选项,例如--region
像这样:
**--region** <region_name>
在 ReST 中,然后使用 Sphinx 为我生成 HTML 和手册页。
这在生成手册页时效果很好,但在生成的 HTML 中,--
变成-
这是不正确的。我发现如果我将源 ReST 文档更改为如下所示:
**---region** <region_name>
HTML 生成正确,但现在我的手册页有---
代替--
。亦不正确。
我尝试用反斜杠字符转义破折号(例如\-\-
)但这没有效果。
任何帮助将非常感激。
这是 Sphinx 中的一个配置选项,默认情况下处于启用状态:html_use_smartypants
选项 (http://sphinx-doc.org/config.html?highlight=dash#confval-html_use_smartypants http://sphinx-doc.org/config.html?highlight=dash#confval-html_use_smartypants).
如果关闭该选项,则如果需要短破折号,则必须使用 Unicode 字符“–”。
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)