如何将格式文本中的选项列表格式化为应使用Sphinx呈现为手册页的格式？

Question

我打算将命令行工具的文档编写为restructuredtext。 我正在使用Sphinx渲染文档。 在html目标旁边，我想使用man目标，以提供可在终端中读取的文档。

尽管我在Sphinx文档中找到了相关的配置变量，但没有遇到提示或示例如何格式化文档源以实现选项列表，如手册页中常见的两列表格。

是否有围绕html 和 man目标的良好做法的准则？

Answer 1

reStructuredText支持选项列表。 请参阅http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#option-lists 。

这对HTML和联机帮助页输出均适用。 没有特殊指令； 您只需创建一个两列表，如下所示：

-h, --help      Show help message and exit
--debug         Turn on debug logging
--verbose       Turn on verbose output