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に近いのか?
一般ユーザでテストドキュメントを作成してみた。
気になったこと、問題になったこととしては
- デフォルトのデザインがもう少しなんとかならないかな。
- ファイル名を間違えた。警告をうっかり見過ごした。
- ソースをみるで、日本語が化ける。文字コード指定がないのか。
ドキュメントの作成とリリース、メンテナンス、公開については
- リポジトリ内でプレーンテキストで保管
- プレーンテキストでVersion管理
- 自動バッチでサイトにアップし、一気にコンパイル
- プロジェクト管理システム内にドキュメントリンクを張る
0 件のコメント:
コメントを投稿