我正在构建一个Python包，并使用Sphinx创建文档。除了我的包代码，我还包括很多使用argparse的命令行Python脚本。我想知道是否有办法让Sphinx自动记录这些脚本？最终目标是一个漂亮的脚本列表，以及相关的帮助打印，参数和选项。要清楚，我正在寻找一种预先存在的方法来做到这一点，而不是自己实现这一点的方法。
如果有更合适的S.E.，这不像我通常在S.O.上提出的问题那样具体。网站发布此问题，请告诉我。谢谢。
答案 0 :(得分：22)
使用sphinx-argparse扩展名：
答案 1 :(得分：17)
您可以使用sphinxcontrib.programoutput在文档中包含命令行中的帮助消息。
这不是argparse特有的，但可用于将任何脚本打印帮助消息记录到命令行。
答案 2 :(得分：4)
您可以使用sphinxcontrib.autoprogram。 pip install sphinxcontrib-autoprogram，然后放
extensions += ['sphinxcontrib.autoprogram']
在conf.py中。要通过使用argparse cli.py对象cli（可以是Python表达式，如函数parser）导入parser来记录命令get_parser()，请使用
.. autoprogram:: cli:parser
:prog: cli.py