28

私は Python パッケージを構築しており、Sphinx を使用してドキュメントを作成しています。パッケージ コードとは別に、argparse を使用する多くのコマンド ライン Python スクリプトも含めます。Sphinx でこれらのスクリプトを自動文書化する方法があるかどうか疑問に思っていましたか? 最終的な目標は、関連するヘルプの出力、引数、およびオプションを含む、きれいに印刷されたスクリプトのリストです。明確にするために、私はこれを自分で実装する方法ではなく、これを行う既存の方法を探しています。

これは、私が通常 SO で尋ねるほど具体的な質問ではありません。この質問を投稿するためのより適切な SE サイトがあれば、お知らせください。

4

3 に答える 3

27

sphinx-argparse 拡張を使用します。

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

于 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オブジェクト( function のような Python 式) をcli.pyインポートしてコマンドを文書化するには、次を使用します。cliparserparserget_parser()

.. autoprogram:: cli:parser
   :prog: cli.py
于 2016-08-09T02:37:55.293 に答える