Sphinxという素敵なドキュメント作成ツールを紹介

e323

今日はいつもと毛色の違う話題です。
少々職業が絡んでいるようなことですが、普段ドキュメント(文書)を書くにあたって皆さんはどういったツールを使っていますか?
Microsoft Word, Apple Pages, Libre Office, KeynoteやExcelでも文書はつくりますね。
僕は普段お仕事で行程管理だとかAPI一覧だとかはGoogle Driveを活用して同じチームで共有していました。
または、長期間情報共有が発生しそうな場合は別途Facebookの非公開グループ機能やWordpressをくりぬいたシンプルなCMSを使ったり。

正直そういうのってけっこう手間なんですよね。
オンラインで共有するときは文書もオンライン上で作成しなくていけなかったり、動的なモノがゆえに動作がちょっと重かったり。
Wordpressくりぬいて、というのに関してはfunctions.phpまでいじりはじめてしまって本末転倒なことになったりします。※僕の場合
Evernoteを使い倒そうと思ったこともありますが、EvernoteってEmacsから使いづらくて結局幽霊アカウントになっています。※宗教上の問題です

そこで見つけたのがPython製ドキュメンテーションツール「Sphinx」です。
前々からちょこちょこ名前は見ていたのですが実際どういったモノかは知りませんでした。
というか忙しすぎて新しいことに手を出している余裕がなかったのです。
が!昨日からちょっと余裕ができた(=社内ぼっち)ので「Sphinx」を使ってみる事にしました。

仕事の引き継ぎのため、今携わっているプロジェクトの要項をまとめてくれ、とのことだったのでとてもちょうどよいタイミングでした。
PDFだけでなく、できればWeb上でさくっと共有したい。
できれば動的ではなく静的なモノが更新されてほしい、そう思っていたところ「そんなこと簡単さ。そう、Sphinxならね」ということを発見しました。
しかもePub形式もつくれるとのこと。
電子書籍好きな方には嬉しい共有方法ですね。

まぁ何はともあれ一度「Sphinx Users JP」を訪れてみてください。
コマンドライン(別名黒い画面)を使わなくてはいけない雰囲気がありますが、普段使わない方はちょっとテンション上がるはずです。
実際インストールさえ終わってしまえば難しいことはほとんどありません。
「make html」とでも打っておけばそれだけで「黒い画面使える人」気分を味わえます。
ついでなので簡単なUNIXコマンドも覚えるといいかもしれません。
人生が捗ります。

もちろんオリジナルのテンプレートを作成することもできるし独特の記法は慣れるとけっこう素敵。(といってもまだSphinx歴一日ですが)
昨日就業時間の半分ほどSphinxでがりがりと文書作成した感想です。
ややステマ風味がある記事になってしまいましたが久しぶりに「これ使える!」と思って嬉しかったのでご紹介した次第です。
2010年から上記の日本ユーザーの会はあるようなので実はけっこう遅かったりするのかもしれませんが、バージョンも1.1系になりもっと使う人増えるんじゃないかな、と思っております。

オンライン系の文書管理で新しいツールを求めている方は是非!
以下、主要リンク。
Sphinx-Users.jp
Sphinxで文章を書く際のEmacs環境設定 2012.12版 via YAMAGUCHI::weblog
iTerm2 ※これは「黒い画面」アプリです。デフォルトの黒い画面よりも使い勝手が良い。Mac専用。

One thought on “Sphinxという素敵なドキュメント作成ツールを紹介

  1. Pingback: ところでSphinxはじめてみた | weblog

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s