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

时间:2016-11-14 14:49:53

标签: python-sphinx restructuredtext man

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

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

是否有针对html man目标的良好做法的指导原则?

1 个答案:

答案 0 :(得分:2)

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