このエントリーをはてなブックマークに追加

sphinxでrubyタグを使う

rubyと言っても、ruby-langではありません。HTML5で規定されたrubyタグ、ルビを振るタグです。

rubyロールを定義するsphinxcontrib-textstyleというのを作りましたので、報告します。

設定

% pip install sphinxcontrib-textstyle

としたあと、conf.pyで

extensions = ['sphinxcontrib.textstyle']

とすればOKです。いつもどおりですね。

使い方

これから :ruby:`強敵<とも>` に会いにいく

とか書いておくと 「これから強敵(とも)に会いにいく」 ってな感じで表示されます。

なお、Firefoxではrubyタグに対応しておりません。その場合、括弧()つきで表示されると思います。

ちなみにHTMLとepub出力に対応しておりますので、rubyタグに対応しているepubビューワーではちゃんとルビが振られて読めると思います。mobiに変換したときにどうなるかはまだ試していません。

設定

前述のとおり、Firefoxなどのrubyタグに対応していないブラウザでの見せ方をconf.pyで以下のようにして定義できます。

rubytag_rp_start = '['
rubytag_rp_end   = ']'

startとendで定義します。標準は()です。なお、ある特定の一ヶ所だけ変えたい、ということはできません。

del

これだけだとなんなので、delも定義してみました。

こういう :del:`いい` だめな感じ

と書くと「こういういいだめな感じ」となります。

まとめ

rubyタグを表示できる拡張を作りました。ついでにdelタグにも対応しました。

これだけだとまだなんなので、これも追加して、というのがあれば追加します。issuesにご登録ください。

あと、名前がいけてないと思っているので募集中です。