我正在构建一个 Python 包，并使用 Sphinx 创建文档。除了我的包代码之外，我还包含了许多使用 argparse 的命令行 Python 脚本。我想知道是否有办法让 Sphinx 自动记录这些脚本？最终目标将是一个漂亮打印的脚本列表，以及相关的帮助打印、参数和选项。需要明确的是，我正在寻找一种预先存在的方法来做到这一点，而不是自己实现这一点的方法。
这不像我通常在 SO 上提出的那样具体问题，如果有更合适的 SE 网站发布此问题，请告诉我。
问问题
5587 次
3 回答
27
使用 sphinx-argparse 扩展：
于 2013-09-05T10:54:24.003 回答
18
您可以使用sphinxcontrib.programoutput在文档中包含来自命令行的帮助消息。
这不是特定于argparse但可用于将任何脚本打印帮助消息记录到命令行。
于 2012-06-05T08:19:09.473 回答
7
您可以使用sphinxcontrib.autoprogram. pip install sphinxcontrib-autoprogram, 然后放
extensions += ['sphinxcontrib.autoprogram']
在你的conf.py. 要通过使用 argparse对象（可以是 Python 表达式，如函数）cli.py导入来记录命令，请使用cliparserparserget_parser()
.. autoprogram:: cli:parser
:prog: cli.py
于 2016-08-09T02:37:55.293 回答