sphinxcontrib.kana-text 0.21.1

KanaText class extends the functionality of Text class, for someone who use index/glossary directives.

extends the functionality of the Text class. any person, who use index/glossary directives with Japanse Kanji, is to be so happy.

conf.py

First of all, add sphinxcontrib-kana_text to sphinx extension list in conf.py

extensions = ['sphinxcontrib.kana_text']

#html_kana_text_on_genindex = False
#html_kana_text_use_own_indexer = 'large'

Warning

You need ‘genindex.html’ for taking True on html_kana_text_on_genindex.

rst file

then use index directive, glossary directive, index role and kana role.

You can specify the follwings:

.. index:: ようご|用語^21

.. glossary::

   ようごいち|用語壱^212
     用語１の説明。

And you can also use index/kana role.

夜空に浮かぶ\ :index:`あまた|数多^21`\ の星々が\ :kana:`きらめいて|煌めいて^2c`\ いる。

build

finally, build your sphinx project:

$ make kana

take a look at genindex.html.

genindex.html

$ sphinx-kana-genindex
$ mv genindex.html.sample path_to_sphinx_project/_templates/genindex.html

CHANGES

• 2021-10-04 0.21 refactoring: KanaText, KanaValue.

• 2021-09-30 0.20 refactoring: unittest.

• 2021-09-30 0.19 handle homonymous functions by each name.

• 2021-09-28 0.18 command ‘sphinx-kana-genindex’

• 2021-09-27 0.17 released on pypi.