究極のドキュメント管理を考える 2 (docutils reStructuredText)

究極のドキュメント管理をするために、必要なツールとして、
ReStructuredText(以後reSTとする)がある。

reStructuredText はソースコードの状態で高い可読性を持つように設計された軽量マークアップ言語。reStructuredText パーサは テキスト処理フレームワークである Docutils のコンポーネントのひとつで、Python で実装されている。
reStructuredText は RST、reST、ReST と略されることもある。

wiki形式と考え方は非常に似ている。
reSTの文法については、はやわかり reStructuredTextがわかりやすい。

Debianでのインストールは、以下の通り

$ sudo aptitude install python-docutils

python-docutilsの中に、

-rwxr-xr-x 1 root root 9348 2008-07-24 18:44 /usr/bin/rst-buildhtml
-rwxr-xr-x 1 root root  593 2008-07-24 18:44 /usr/bin/rst2html
-rwxr-xr-x 1 root root  594 2008-07-24 18:44 /usr/bin/rst2latex
-rwxr-xr-x 1 root root  726 2008-07-24 18:44 /usr/bin/rst2newlatex
-rwxr-xr-x 1 root root  600 2008-07-24 18:44 /usr/bin/rst2pseudoxml
-rwxr-xr-x 1 root root  636 2008-07-24 18:44 /usr/bin/rst2s5
-rwxr-xr-x 1 root root  601 2008-07-24 18:44 /usr/bin/rst2xml
-rwxr-xr-x 1 root root 2613 2007-09-15 06:35 /usr/bin/rstart
-rwxr-xr-x 1 root root 1435 2007-09-15 06:35 /usr/bin/rstartd
-rwxr-xr-x 1 root root  669 2008-07-24 18:44 /usr/bin/rstpep2html

このようなスクリプトが同梱されているので、
github にある documents/test/READMEのようなreST文書をHTMLにしたいとき

$ /usr/bin/rst2html README > README.html

とすることで簡単にHTMLが作成できる。
こちらにHTMLをアップロードしたので確認どうぞ

みためしょぼ！って思った人は、

$ /usr/bin/rst2html --stylesheet=hoge.css README > README.html

で好みのcssをかませることが出来るので無問題。

reSTの長所は、テキストの状態ですでに見やすい文書で、
それをコマンドラインから複数の形式の文書に
（テキスト形式の状態とほとんど変わらない見た目で）
変換出来ることにあると思います。

興味がある方は是非使ってみることをおすすめします。

その他リンク
パワーポイントのような見せ方もできます。



くったりぬいぐるみ (きれいずきん生活)