YAMAGUCHI::weblog

土足で窓から失礼いたします。今日からあなたの息子になります。 当年とって92歳、下町の発明王、エジソンです。

JUS勉強会でSphinxの紹介をしました

はじめに

こんにちは、Python界の海老蔵です。去る2010年12月3日にJUS勉強会にてSphinxの紹介をさせていただきました。その時に少々トラブルがあり、ご紹介したかったリンクなどが残念ながら紹介できなかったのでここにリンクや当日のスライドを貼っておきます。

参考

発表資料

発表に使ったスライドはこちらに置いておきます。

諸々ご紹介

reSTを書くのに適したエディタは?

reSTはただのテキストなのでWindowsのメモ帳でも構いません。ただやはりreST用のハイライトをしてくれるものが良いと思います。EmacsVimなどでシンタックスハイライトしてくれるのですでに使っている方は拡張の設定をされることをおすすめします。
EmacsでreSTを書く設定は以前こちらのブログでもご紹介しました。

テンプレートの作成

ドキュメントの生成を行う際には複数の形式(HTML, LaTeX, PDF, ePub, manなど)で出力できるわけですが、特にHTMLを生成する例が多いように感じられます。やはり生成するときはある程度カスタマイズしたくなると思いますので、参考になるリンクを紹介します。

ドメイン

Sphinxドメインを使うことで、多くの略記を作ることが出来ます。たとえばJUS勉強会のときに清水川さんが紹介していたような議事録に関しても、議事録ドメインを作ることで表記を簡略化することも可能です。
また3rd Partyのドメインも下記のレポジトリにあります。何かドメインが必要だなと思った場合はまずこちらを覗いてみてください。

sdedit (Quick Sequence Diagram Editor)

UML図をテキストで記述してSphinxで図を生成することが出来ます。詳細はこちら。

blockdiag

状態遷移図をテキストで記述してSphinxで図を生成することができます。詳細はこちら。

おわりに

Sphinxは知れば知るほどその奥深さや応用範囲の広さに驚かされます。編集にWordのような優れたUIがないのが悔やまれますが、それもこれから出てくることでしょう。セットアップなど非常に簡単なので、まずは試しに30分触ってみてください。Sphinx-Users.jpのチュートリアルでは30分もあれば簡単な使い方は習得できると思います。
Sphinx自身、あるいはSphinx-Users.jpの活動に関してコメントなどある場合は、是非下記サイトにある連絡先へご連絡下さい。