我将如何格式化重组文本中的选项列表,这些选项列表将呈现为带有 Sphinx 的手册页?

How would I format a list of options in restructured text that shall be rendered as man page with Sphinx?

我打算将命令行工具的文档编写为重组文本。我正在使用 Sphinx 来呈现文档。在 html 目标旁边,我想使用 man 目标,以便提供可以在终端中读取的文档。

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

是否有任何指南涵盖 html man 目标的良好做法?

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

这应该适用于 HTML 和联机帮助页输出。没有特别的指示;您只需创建一个两列 table,如下所示:

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