PyDoc は、モジュールのドキュメントを生成するときに、現在のディレクトリに HTML ドキュメントを作成します。PyDoc が呼び出されるディレクトリではなく、生成されたドキュメントのプレースホルダーとなる別のディレクトリを指定する必要があります。
python -m pydoc -w <MODULES_DIR>
ドキュメントの生成に使用しています。
これは可能ですか?
私は同じ問題を抱えていて、それを理解しようとしてこの質問に出くわしました。私もそれを行う方法を理解できなかったので、これが私の解決策です。pydoc をだまして特定の場所に出力しようとするのではなく、現在のディレクトリにドキュメントを生成し、ファイルを必要な場所に移動するだけです。
私の場合、ターゲット フォルダーの名前は「doc」で、ソースは「semlm」ディレクトリの下にあります。
mkdir -p doc
pydoc -w `find semlm -name '*.py'`
mv *.html doc
(必要に応じて pydoc コマンドをカスタマイズできるはずですが、これが私にとってはうまくいきました)。
毎回これをすべて入力したくなかったので、Makefile に入れました。ここに抜粋があります:
.PHONY: doc
doc:
mkdir -p doc
pydoc -w `find semlm -name '*.py'`
mv *.html doc
これ.PHONY: doc
が必要なのは、Makefile ターゲットが最上位ディレクトリ (つまり 'doc') のフォルダーと同じ名前を持っているためです。これで、次を実行してドキュメントを doc フォルダーに生成できます。
make doc
もっとエレガントな方法があるかもしれませんが、これは私が今まで見つけた中で最高のものです。
pydoc -w ...
モジュールの HTML ドキュメントを現在のディレクトリのファイルに書き出します。「/」が含まれている場合は、ファイル名として扱われます。ディレクトリを指定すると、すべての内容についてドキュメントが書き込まれます。