SphinxCon JP を開催することにしました
すでに渋谷では SphinxCon 開催の話題でもちきり状態で、
ご存じない方はもういらっしゃらないとは思いますが、今年も SphinxCon JP 2014 を開催します。
今年も SphinxCon JP を開催することになりました!10/26(日)です。発表者、参加者の募集を始めたので、興味がある方はお気軽にご参加ください! #sphinxjp / http://t.co/N0dqpfEt7U
— sphinx-users.jp (@sphinxjp) 2014, 9月 6
ノリと勢いで 2012, 2013 とやってきていましたが、なんと 3年目を迎えることになりました。
参加者も発表者も募集しているので、興味がある方はお誘い合わせの上登録をお願いします。
今年の状況によっては、2015 の開催につながるかもしれないので、ちょっとでも興味があれば飛び込んでみてください*1。
さて、この SphinxCon JP の開催までは精鋭スタッフの努力によって成り立っています。
今年はそのリーダーとして @usaturn 氏が先頭に立ち、来るイベント当日に向けて準備を進めています。
そこで、今回はリーダー @usaturn 氏のために、新たに Sphinx 拡張を作ってみました*2。
それが sphinxjp.usaturn です。
sphinxjp.usaturn は warning や note などの、admonition と呼ばれるテキストブロックの記述に用います。
sphinxjp.usaturn の設定を行うと usaturn ディレティブが追加され、
reST の中でうさたーんに注意書きをしゃべってもらうことができます。
たとえば
.. usaturn:: こんにちは、私はうさたーんです。
とマークアップを行うと、次のように変換されます。
また、sphinxjp.usaturn は add_character_admonition という API を提供しているため、
conf.py で設定を書き加えることでうさたーん以外にも喋らせることができます。
この機能を用いると、キャラクターの対話形式の記事も簡単に作ることができます。
.. usaturn:: こんにちは、私はうさたーんです。 .. shimizukawa:: こんにちは、私はペンです。 :align: right .. usaturn:: いいえ、それはペンではありません。久美です。 .. shimizukawa:: ケン、座ってください。 :align: right .. usaturn:: 私も寿司が好きです。
とっても便利ですね。
まとめ
- SphinxCon JP 2014 が開催されます。スピーカーも参加者も大募集中です。
- sphinxjp.usaturn というモジュールを作りました
- 犯人はこいつです
@tk0miya 今年のテーマは…のあたりに吹き出し付けて顔写真載せるか
— Takayuki Shimizukawa (@shimizukawa) 2014, 9月 6
*1:Sphinx だけではテーマが限られてしまうので、どうせなら次は他のドキュメンテーションツールを混ぜつつ、DocTool Conf みたいに昇華できるといいのではないかとか、妄想はいろいろありますね。他のツールの状況とかも聞いてみたいし!
*2:sphinx-users.jp 界隈では敬意や感謝を表すために Sphinx 拡張を贈り合う習慣があるとかないとか... 参考: sphinxjp.shibukawa, sphinxjp-tk0miya