はじめに

Sphinx は説明書を楽に作れるように考えられたソフトウェアだそうです。

• 日本語情報サイト
• 日本語訳説明書
• 英語本家

現状でもそれなりに日本語を扱えますが、使ってみると地味ながら重要な問題が解決されていないことがわかります。

• ファイル名やページ内リンクに英語しか使えない、使わない。
• 索引(genindex.html)で仮名も漢字もみんな Symbols になってしまう。
• 用語集 (glossary ディレクティブ) で並べ替えが Unicode 符号順しか使えない。
• NFD で正規(?)化するので濁音が混じるとかな文字でさえ辞書順にならない。

これらを Sphinx の拡張の形で解決を試みたのがここで紹介しているソフトウェアです。

最終的な成果物でやっていることはさほど難しいわけではありませんが、そこにたどり着くまでに結構な手間が掛かっています。 これは重要、これは便利、いいぞもっとやれと思われた方は是非とも寄付またはその他の援助をお願いいたします。

この拡張(Extension)は Sphinx や docutils の実装に依存しています。本エクステンションに関係のある変更が行われると、当拡張が機能しなくなったり Sphinx の本体側で追加されたはずの機能が動作しなかったりすることがあります。現在どの版の Sphinx, docutils および Python で動作確認をしたのかについては履歴 を参照ください。

このような場合はお手数ですがソースコードを再修正ください。何をどうしたのかは一応わかるようにコメントをいれてあります。

なお、筆者は html 出力でしか動作を見ておりません。たとえば utf-8 での出力を前提にしているせいで HTML Help(.chm)では使えない、とかいう不具合が出る可能性があります。