2. Sphinxを使ってみよう！¶
2.1. ドキュメント作成にははどんなフォーマット使ってますか？¶
皆さんは普段、ドキュメントはどのような形式で作っていますか？ MS-OfficeのExcel、Word、PowerPointや、このメールマガジンのように 単なるプレーンテキストで作成している場合が多いのではないでしょうか？
MS-Office製品
Office製品は大抵の現場で使えますし、使い始める際に手間がかからない、 誰でも編集できる手軽さがあります。 また図や矢印等も簡単に配置できて見栄えを良くする事が簡単にできます。
しかし一方で、修正する際にオブジェクトの位置を微修正したり、 Office特有のおせっかい機能にイライラしたり、あちこちに誰が 編集したのかもわからないバックアップファイルが散乱しやすい といった側面もあるかと思います。
プレーンテキスト
プレーンテキストも環境を選ばない絶対的なお手軽さがあるのですが、 見栄えをよくしようとすると記号を多用したり自分ルールのインデントを 適当に入れたりして大変になりますし、何より画像データの挿入等、 Officeフォーマットに比べて、できる事が少ないですし見た目が貧弱です。
2.2. もっと手軽にストレスなく書けるフォーマットは無いの？¶
そこで、お手軽にドキュメント作成、編集、見栄えもよくできるツール
- Sphinx
をご紹介しましょう。特徴は、
- プレーンテキストで書ける
- reSTという簡単なマークアップで書くことができます。PukiWikiや MediaWikiを使ったことがある人なら、Wiki記法に似てると 思われるかもしれません。
- プレーンテキストなのでMercurial等のバージョン管理ツールで自在に管理可能。
- html、pdf等の色々な形式に変換可能
- 他にもman、Windowsヘルプ、epub、latex等々
- Wiki同様にリンクを張り巡らせる事によって目的の情報に到達しやすい
- ファイルを後から付け足していく形でドキュメントを無理なく成長させやすい
- ファイルが散らばらない
- 閲覧するのは完成したhtmlやpdfであり、reSTファイルさえ バージョン管理しておけば古い物は全て削除しても問題が無い。
2.3. Sphinxのイメージが湧かないって？¶
実は、このSphinxの記事はreSTで書いてます。
これをhtml化すると、このページになります。
しかもhtml化も簡単で
make html
と打つだけ。
2.4. Sphinxを使ってみよう！¶
まず、ここを見れば全てがわかります。
次に、初心者向けのSphinx勉強会に参加してみましょう。
Sphinx ハンズオン #3
この勉強会の参加資格は特にありません。Sphinxの知識が 0 で問題ありません。 ノートPCが必要ですが、持ってないけど参加したいという方には先着1名様に 私がお貸ししますので事前にご相談下さい。
twitter、mixi、Google、Yahoo等のIDがあれば簡単に参加登録できます。
Note
講師役で私(山田)も参加しますので気軽に参加して下さい。
enjoy Sphinx!
