我使用的狮身人面像记录用Python编写的一个命令行工具。 我希望能够记录一个命令行选项,如--region
是这样的:
**--region** <region_name>
在休息,然后用狮身人面像对生成我的HTML和手册页对我来说。
生成手册页,但在生成的HTML中,当这个伟大的工程--
被变成了-
这是不正确。 我发现,如果我改变我的源REST文档看起来像这样:
**---region** <region_name>
HTML生成正确的,但现在我的男人网页有---
而不是--
也是不正确的。
我试着用反斜杠字符转义破折号(例如, \-\-
但没有任何效果。
任何帮助将非常感激。
这是狮身人面像的配置选项默认是打开的:在html_use_smartypants
选项( http://sphinx-doc.org/config.html?highlight=dash#confval-html_use_smartypants )。
如果关闭该选项,那么你将不得不使用Unicode字符 - 如果你想要一个短破折号'。
同
**-\\-region** <region_name>
它应该工作。
要添加两个破折号,添加以下内容:
.. include:: <isotech.txt>
|minus|\ |minus|\ region
注意反斜线和空间。 这避免了减号和参数的名称之间的空间。
你只需要包括isotech.txt
每页一次。
有了这个解决方案,您可以继续扩展聪明的家伙,并在您需要的文本的每一部分写两个破折号。 不仅仅是在选项列表或文字。
在狮身人面像1.6 html_use_smartypants
已被弃用 ,并且不再需要设置html_use_smartypants = False
在你conf.py
或作为参数传递给sphinx-build
。 相反,你应该使用smart_quotes = False
。
如果你想使用以前提供的转换html_use_smartypants
,而是建议使用smart_quotes
,例如, smart_quotes = True
。
请注意,在写这篇文章的时间阅读文档针sphinx==1.5.3
,它不支持smart_quotes
选项。 在那之前,你需要继续使用html_use_smartypants
。