うまいぼうぶろぐ

linuxとhttpdとperlのメモ

sphinx でtext からドキュメント作成

このような、プログラマーがドキュメントを書きたくなってしまうすばらしいツールに乾杯!”

reST(reStructuredText; HTTP の RESTじゃないyp) でテキストを書いて、ドキュメントに変換する。markdown、wiki記法みたいなもの?

blockdiag からsphinx を知ったんですが、なかなか良い感じですね。make html, make pdf, make latex, などで色々作れるし! make pdf するには rst2pdf というpython ライブラリがいるのでeasy_install しとく。(もしくは latex からpdf 作るか?)

特徴

install

debian/ubuntu にはapt packageあった。

$ sudo apt-get install python-sphinx

だけど、自分の環境ではapt でinstallされたversion (0.6.6) でmake pdf が失敗したのでeasy_install で最新版入れたほうがいいかも。