4

我正在使用 Sphinx/reStructuredText 为项目创建 HTML 和 PDF 文档,并且包括命令行工具的 argparse 帮助的输出。目前我正在手动粘贴输出,但计划在某个时候切换到自动生成的输出。

问题是,虽然命名参数(如 -x 或 --xray)的格式很好,但它不适用于位置参数。看起来参数名称上缺少前导“-”会让人感到困惑。输出看起来像普通文本,没有整齐的缩进等。

所以我的问题是,是否存在强制格式化位置参数的标记,就好像它们有前导“-”字符一样?如果没有,有人可以建议我应该在文档或代码中的哪个位置开始寻找自己的东西吗?

4

1 回答 1

4

您可以使用sphinx-argparse扩展。它不使用argparse帮助的输出,而是自省argparse解析器本身,并为位置参数和选项提供适当的sphinx标记,将它们格式化为带有适当标签的定义列表。

子命令也很容易处理。

http://sphinx-argparse.readthedocs.org/en/latest/

它还将满足您在以下方面的需求:

计划在某个时候切换到自动生成的输出

于 2013-09-17T10:40:12.880 回答