Python sphinx 我将如何格式化重组文本中的选项列表,这些选项将以Sphinx手册页的形式呈现?

Python sphinx 我将如何格式化重组文本中的选项列表,这些选项将以Sphinx手册页的形式呈现?,python-sphinx,restructuredtext,manpage,Python Sphinx,Restructuredtext,Manpage,我计划将命令行工具的文档编写为restructuredtext。我用斯芬克斯来渲染文档。除了html目标之外,我想使用man目标,以便提供可以在终端中读取的文档 虽然我在Sphinx文档中找到了相关的配置变量,但我没有遇到如何将文档源格式化以获得一个选项列表的提示或示例,就像在手册页面中常见的两列表一样 是否有关于html和man目标的良好实践的指导原则?在StructuredText中支持选项列表。看 这应该适用于HTML和手册页输出。没有特别指示;您只需创建一个两列表,如下所示: -h, -

我计划将命令行工具的文档编写为restructuredtext。我用斯芬克斯来渲染文档。除了
html
目标之外,我想使用
man
目标,以便提供可以在终端中读取的文档

虽然我在Sphinx文档中找到了相关的配置变量,但我没有遇到如何将文档源格式化以获得一个选项列表的提示或示例,就像在手册页面中常见的两列表一样


是否有关于
html
man
目标的良好实践的指导原则?

在StructuredText中支持选项列表。看

这应该适用于HTML和手册页输出。没有特别指示;您只需创建一个两列表,如下所示:

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