buildout を使用して多数の cmdline ツールを生成し、Sphinx を使用してドキュメントを生成するプロジェクトがあります。
コマンドラインのコード定義の近くにドキュメントを記述し、各コマンドのコードからのドキュメント文字列を使用して、Sphinx にすべてのコマンドのドキュメントを 1 ページに生成させる方法はありますか?
質問する
237 次
1 に答える
0
部分的な解決策は、"autofunction" ( autodoc のドキュメントを参照) を使用してコードを文書化することです。たとえば、次の.rstようなファイルを使用します。
Command line tools
==================
.. autofunction:: mypackage.tools.do_something
.. autofunction:: mypackage.importtasks.import
.. autofunction:: mypackage.feed_the_cat
これは、見栄えがよくないかもしれない関数のようにそれらを文書化します。
もう 1 つの解決策は、.rst自分で docstring から適切なファイルを生成することです。それを sphinx ディレクトリに生成し、そこから使用できます。例として、私がツールのコレクション用に生成した README.rst (あなたのもののような console_scripts エントリ ポイント) と、 README を生成するスクリプトを見ることができます。
基本的に、一連のファイルを繰り返し処理し、関連する.__doc__項目をテキスト ファイルに追加します。からエントリを使用setuptoolsまたはpkginfo取得する方法が見つかりませんでしたが、カスタムスクリプトで必要に応じて実行できることです:-)console_scriptssetup.py
于 2012-11-18T18:26:25.233 に答える