PyDocにユーザ定義ディレクトリへのドキュメント生成を指示する方法

Question

PyDocは、モジュールのドキュメントを生成するときに、現在のディレクトリにHTMLドキュメントを作成します。 PyDocが呼び出されるディレクトリの代わりに、生成されたドキュメントのプレースホルダとなる別のディレクトリを指定する必要があります。

私はpython -m pydoc -w <MODULES_DIR>を使用してドキュメントを生成しています。

これは可能でしょうか？

Answer 1

pydocの-w ...

は現在 ディレクトリ内のファイルへのモジュールのためのHTML文書を書きます。 '/'が含まれている場合、ファイル名として扱われます。ディレクトリ名を とすると、すべての内容のドキュメントが作成されます。

Answer 2

私は同じ問題を抱えていましたが、この問題を理解しようとしました。それをどうやって行うのか分からなかったので、これが私の解決策です。特定の場所に出力するためにpydocをトリックしようとするのではなく、現在のディレクトリにドキュメントを生成し、必要な場所にファイルを移動しています。

（あなたはあなたが望むようpydocコマンドをカスタマイズすることができるはず私の場合、ターゲットフォルダが「DOC」と命名され、ソースが「semlm」ディレクトリ

mkdir -p doc 
pydoc -w `find semlm -name '*.py'` 
mv *.html doc 

の下に配置されていますが、これは私のために働いたものです）。

毎回これをすべて入力しないので、Makefileに入れました。ここで抜粋である：

.PHONY: doc 

doc: 
    mkdir -p doc 
    pydoc -w `find semlm -name '*.py'` 
    mv *.html doc 

Makefileのターゲットは、最上位のディレクトリ（すなわち、「DOC」）内のフォルダと同じ名前を持っているので.PHONY: docが必要です。今、私は実行することによって、ドキュメントフォルダにドキュメントを生成することができます

make doc 

はおそらく、よりエレガントな方法があるが、これは私がこれまでに見つけた最高です。