KanaText class extends the functionality of Text class.
Project description
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'
rst file
then use index directive, glossary directive, index role and kana role.
You can specify the follwings:
.. index:: ようご|用語^21
.. glossary::
ようごいち|用語壱^212
用語1の説明。
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.thml
CHANGES
2021-09-30 0.19 count homonymous functions by each name.
2021-09-28 0.18 command ‘sphinx-kana-genindex’
2021-09-27 0.17 released on pypi.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Close
Hashes for sphinxcontrib.kana_text-0.19.0.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 60e6a44dbfb452e244aeb2cb5e0dc5a269b023150acdc73e7af7285667c0010b |
|
MD5 | a6439dbca21898e1d4b8a9c2cee3bd19 |
|
BLAKE2b-256 | 3fbc0bbce2cbda0021cb5dc91bfa845fa7021ad611725727d123758293a65e56 |