标记为argparse的Sphinx格式

Question

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

问题在于虽然格式化对于命名参数（例如-x或--xray）很好，但它在位置参数上不能很好地工作。看起来参数名称上没有前导' - '会让人感到困惑。输出看起来像普通文本，没有整齐的缩进等。

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

Answer 1

您可以使用 sphinx-argparse 扩展名。 它不使用 argparse 帮助的输出，但它反过来反映 argparse 解析器本身，并为位置参数和选项提供正确的 sphinx 标记，格式化它们作为具有适当标签的定义列表。

子命令也很容易处理。

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

它还将满足您的需求：

  

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