2011年05月18日

sphinx セットアップしてみたよ in Windows

sphinx とは,『文書を書くのが楽しくなってしまうツールです』.

こんな文言をみつけて,仕様書をかいたりするのがいつも後回し,結果作成に時間がかかっている自分は興味津々.4月からインストールして,四苦八苦してを繰り返してきたので振り返る意味でもメモする.


結論からかけば,sphinxをインストールしてかなり嬉しい.日本語環境のセットアップやPDF出力など手間取ったし,sphinx で作成したPDFに空白ページが挿入されてしまったり,まだマークアップを理解出来ていなかったり,BlockdiagやPlantUMLなどのシーケンス図やブロック図を埋め込むことが失敗に終わってたりして,まだまだこれからな状態なんだけど,Dropboxの中でドキュメントを作成・編集作業をして,会社でも自宅でも色々メモできるようにした.

去年,一昨年の勉強会のメモがまだ残っていて,これらをサクサクemacs上で編集,sphinx でHTML化はもちろん,PDF化してまとめていけるのも嬉しい.


自分の頭にある情報を,自分にとって分かりやすい項目ごとにファイルにして,適当に書き込んでいく.その後,関連あるファイル同士を連結して一つのファイルにするというスタイルはプログラムコードを最終的にそれぞれコンパイルしたものをリンクして,一つの実行ファイルを作成するというスタイルに近い.

ファイルを書きやすいというのと,アウトプットを一つにまとめられるという点,そして各ファイル毎にバージョン管理が行えるという点はとても素晴らしいと思う.

more read...
posted by maplewine at 20:30| Comment(0) | TrackBack(0) | Computer | このブログの読者になる | 更新情報をチェックする
×

この広告は180日以上新しい記事の投稿がないブログに表示されております。