前フリ

Pythonにはpydocというモジュールがあって、これを使うと同じようにAPIリストが出力できると思っていた。今までDjangoのコードを書いてみて、いわゆるヘッダーコメントとかドキュメンテーションコメントと言われているものをなんとなくjavadocライクに書いていたが、pydocだとあんまり期待した通りのHTMLを出力してくれないことが分かった。

sphinxでautodocを使用する場合はプライベートメンバー（'_'から始まるメンバー）はデフォルトで非表示となっていて、docstringが出力されない。出力する場合には、autodoc-skip-memberというカスタムメソッドを使用して表示するメンバーを指定すれば良いらしいが、これだと手間が増える。