SphinxでドキュメンテーションコメントをHTMLに変換する方法

前フリ Pythonにはpydocというモジュールがあって、これを使うと同じようにAPIリストが出力できると思っていた。今までDjangoのコードを書いてみて、いわゆるヘッダーコメントとかドキュメンテーションコメントと言われているものをなんとなくjavadocライクに書いていたが、pydocだとあんまり期待した通りのHTMLを出力してくれないことが分かった。 自分が期待していたのは、 @タグでクラス、関数属性に関する情報を出力 phpDocumentorのように、テンプレートを変更可能 というものだったが、あんまりよろしくなかった。調べてみると、epydocというツールで実現できそうだったが、テンプレートはないらしい。もうちょっと調べてみると、Sphinxというドキュメンテーションツールがあるそうだ。すでに、以前のエントリーでちょっとした使い方について書いたが、インストール方法とかを書いて

[nwpct1]

“pythonの場合はdocstringにドキュメントを書いていくので、autodocという拡張機能を使って、出力することになる。”