各種Sphinx拡張 / Sphinx Extensions

自作のSphinx拡張をここに配置しています / Here’s my extension lists.

sphinx_html5_basic_theme

現在のSphinxによるHTML出力は4.01準拠ですが、これをHTML5対応にするための土台を提供しています。 html5_basicのほかにhtml5_sphinxdocも用意しています。

gosyu使用例 や 姫踊子草 で実用例をご覧になれます。

HTML5 versions of html theme ‘basic’ and ‘sphinxdoc’.

Examples are shown at gosyu使用例 or 姫踊子草 (written in Japanese).

unicode_ids

現在のSphinxではURLを強引にASCII文字列の範囲に捻じ曲げてしまうところをページ名・ページ内リンクともに日本語を維持するように修正する拡張です。

gosyu使用例 や 姫踊子草 で実用例をご覧になれます。

Force Sphinx to make the url with non-English characters, both url of pages and anchors in pages.

Examples are shown at gosyu使用例 or 姫踊子草 (written in Japanese).

yogosyu

現在のSphinxではできない、用語集内の五十音配置を実現するための拡張です。

.. index:: を .. yogosyu:: に置き換え、またいくつかの設定を行うことで実現します。総合索引 genindex.html 内も五十音の行毎に並べ直す user_ordered_index_patch もあります。

姫踊子草 で実用例をご覧になれます。

Make general index(genindex.html) sorted by user defined order, especially non-English languages.

Example is shown at 姫踊子草 (written in Japanese).

gosyu

yogosyuと同じ目的で作られた拡張ですが、Sphinx側が用意している独自索引の設置機能を利用しています。

.. gosyu:: で定義した各用語は総合索引ではなく独自の索引ファイルに収まります。その代わり、いくらかSphinxやdocutilsの変化に強くなっています。

gosyu使用例 で実用例をご覧になれます。

The another implementation of yogosyu above. Using domain index feature defined by Sphinx. This means more stable than yogosyu against future changes of Sphinx or docutils.

Example is shown at gosyu使用例 (written in Japanese).

sortorder

yogosyuおよびgosyuの土台となるPythonモジュールです。pipでそれらを設置した時は自動的に追加されます。

Base module of yogosyu and gosyu above. Automatically installed when you use pip with them.

古い版 / Older version