我将如何格式化重构文本中的选项列表，并将其作为手册页呈现给Sphinx？

Question

我正在计划将命令行工具的文档编写为restructuredtext。我使用狮身人面像呈现文档。除了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