Pages

2011年6月27日月曜日

構造化ドキュメント作成管理ツール Sphinxを試す

ドキュメント作成ツール Sphinxが注目されている。ざっと調べてみたが、Wikiと違い構造化ドキュメントを作成するのに適しているようだ。
LaTeXも出力出来るし、アドオンでダイアグラムやUML図もできるようなので、これを私の標準ドキュメントツールとして採用することにした。
日本語サイトは、ここ http://sphinx-users.jp/index.html

さくらVPSへのインストールは、ここを参考にしました。
http://b.l0g.jp/dev/sphinx-on-centos55/

[baker]$ su -
[baker]# yum install python-pip python-setuptools
[baker]# pip-python install sphinx

あっさり、終了。インストールしたパッケージは
  • python-pip -- pythonのパッケージ管理ツール
  • python-setuptools -- パッケージ・インストーラ makeに近いのか?

一般ユーザでテストドキュメントを作成してみた。
気になったこと、問題になったこととしては
  • デフォルトのデザインがもう少しなんとかならないかな。
  • ファイル名を間違えた。警告をうっかり見過ごした。
  • ソースをみるで、日本語が化ける。文字コード指定がないのか。

ドキュメントの作成とリリース、メンテナンス、公開については
  1. リポジトリ内でプレーンテキストで保管
  2. プレーンテキストでVersion管理
  3. 自動バッチでサイトにアップし、一気にコンパイル
  4. プロジェクト管理システム内にドキュメントリンクを張る
で良いだろうか。

0 件のコメント:

コメントを投稿