1. ホーム
  2. python

Pydocでドキュメントを作成するにはどうすればよいですか?

2023-08-05 10:56:04

質問

私のモジュールからドキュメントを作成しようとしています。私は使用した pydoc を Windows 7 で Python 3.2.3 を使ってコマンドラインから実行しました。

python "<path_to_pydoc_>\pydoc.py" -w myModule

この結果、私のシェルは、私のモジュール内の各ファイルに対して1行ずつ、次のようなテキストで埋め尽くされることになりました。

no Python documentation found for '<file_name>'

まるでPydocが私のファイルのドキュメントを取得しようとしているようですが、私はそれを自動作成したいのです。Googleを使っても良いチュートリアルが見つかりませんでした。どなたかPydocの使い方のヒントをお持ちの方はいらっしゃいませんか?

を使って1つのファイルからドキュメントを作成しようとすると

python ... -w myModule\myFile.py

とあるように wrote myFile.html と書いてあり、開くと1行でこう書いてあります。

# ../myModule/myFile.py

また、私のコンピューター上のファイルそのものへのリンクがあり、これをクリックすると、ウェブブラウザーでファイルの中身を表示することができます。

どのように解決するのですか?

RocketDonkeyが提案したように、モジュール自体にいくつかのdocstringを持たせる必要があります。

例えば myModule/__init__.py :

"""
The mod module
"""

また、各ファイルのドキュメントを myModule/*.py を使って

pydoc myModule.thefilename

で、生成されたファイルがメインモジュールのドキュメントファイルから参照されるものと一致することを確認します。