ちまたで人気の Sphinx を試してみたので紹介してみます。
Sphinxとは
Pythonベースで記述されているドキュメンテーションツール。
Wikiのような文法(reStructuredTextという文法)を用いて文章を記述し、
HTMLやLaTexで吐き出すことができる。
プラグインがいろいろ作られていて、たとえば blockdiag プラグインなんかを使うとブロック図を生成したり、コードハイライトしてくれたりするらしい。テンプレート変えたりも当然できるみたい。
Sphinxインストール
python,easy_install,sphinx@RedHat系Linux
sudo yum -y install python sudo yum -y install python-setuptools sudo easy_install sphinx
Sphinxプロジェクトの生成
mkdir -p borabora/docs cd borabora/docs sphinx-quickstart
とりあえず Enter を連打。プロジェクト名とバージョン番号と著者名を記入。
reStructureTextによるドキュメント記述
http://sphinx-users.jp/doc10/rest.html
ビルド
make html
api.rst -> _build/html/api.html
他にも
make latex make latexpdf make epub
所感
PukiWikiやTracのWikiと違って、コマンドでビルドできるのがうれしい。のかな？
http://www.slideshare.net/shimizukawa/sphinx-6084667 を参考にしました。
