Sphinx和argparse - autodocumenting命令行脚本？

Question

我正在构建一个Python包,并使用Sphinx来创建文档.除了我的包代码,我还包括很多使用argparse的命令行Python脚本.我想知道是否有办法让Sphinx自动记录这些脚本？最终目标将是一个漂亮的脚本列表,以及相关的帮助打印,参数和选项.要清楚,我正在寻找一种预先存在的方法来做到这一点,而不是自己实现这一点的方法.

这并不像我通常所问的那样具体,如果有更合适的SE网站发布这个问题,请告诉我.谢谢.

Answer 1

使用sphinx-argparse扩展:

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

Answer 2

您可以使用sphinxcontrib.programoutput在文档中包含命令行的帮助消息.

这不是特定于argparse但可用于将任何脚本打印帮助消息记录到命令行.

Answer 3

您可以使用sphinxcontrib.autoprogram。pip install sphinxcontrib-autoprogram，然后放

extensions += ['sphinxcontrib.autoprogram']

在你的conf.py。要cli.py通过cli与argparse parser对象parser（可以是Python表达式，例如function get_parser()）一起导入来记录命令，请使用

.. autoprogram:: cli:parser
   :prog: cli.py