sphinxを用いてドキュメント生成してみました。OSC東京等で情報は得ていたのですが、ようやく使ってみる機会がありました。

システムとしては、wiki に近いと思います。特定の記号でセクションや箇条書きを指定します。インデントも活用するのは、python らしい設計かもしれません。

私がいいな、と思った特徴は、ソース(HTML 等に変換する前のテキスト)の可読性もかなりの程度確保されていることです。wiki はソースでもまだ読めますが、LaTeX は(LaTeX に習熟していない限り)ソースは読めたもんじゃありません。プログラムソースをそのまま書いて、整形してくれるのも嬉しいですね(例えば、HTML に HTML コードを書くときは、>を>に書き換えるようなことが必要ですが、sphinxでは不要)。この点で、プログラムコードと普通の文が混じるような解説テキストを書くのに非常に便利なツールだと思いました。

楽天で検索
【楽天ブックスならいつでも送料無料】エキスパートPythonプログラミング [ タレク・ジアデ ]
3888円
タレク・ジアデ 稲田直哉 アスキー・メディアワークス KADOKAWA発行年月：2010年05月 ページ数：415p サイズ：単行本 ISBN：97840486
楽天ブックス
Supported by 楽天ウェブサービス