pydocを使ってドキュメント生成をしてみたので簡単にメモしておく。

pydocの使い方

pydocは、Pythonに標準で入っており、docstringで書かれたコメントからドキュメントを作成することができる。
JavaのJavadocのようなもので、HTML形式で出力することもできる。
ドキュメントを出力するには以下のコマンドを実行する。

// 画面表示する場合
$ pydoc <ファイル名>

// HTML形式で出力する場合
$ pydoc -w <ファイル名>

HTML形式の場合は、実行すると「wrote <ファイル名>.html」と表示され、HTML形式のファイルが出力される。
ここで、ファイル名を指定する際には拡張子「.py」は不要である。

また、windowsではPythonをインストールしただけではpydocコマンドが使えないらしい。
windowsでpydocコマンドを使うにはpython.exeと同じディレクトリにバッチファイルを作成する必要がある。
バッチファイルの内容は以下となる。

@python %~dp0\Lib\pydoc.py %*