Metadata-Version: 2.1
Name: sphinxcontrib.kana_text
Version: 0.19.0.1
Summary: KanaText class extends the functionality of Text class.
Home-page: https://qiita.com/tags/sphinxcotrib.kana_text
Author: @koKekkoh
Maintainer: KaKkou
License: BSD 2-Clause License
Keywords: sphinx,sphinxcontrib,japanese,ja,kana_text,glossary,index,kana
Platform: any
Classifier: Development Status :: 4 - Beta
Classifier: Framework :: Sphinx :: Extension
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Education
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: Japanese
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Documentation :: Sphinx
Classifier: Topic :: Utilities
Description-Content-Type: text/x-rst
License-File: LICENSE

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

.. image:: https://i.gyazo.com/c323abb56cb7233abbc425c063c9e0d5.png

conf.py
-------

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

.. code-block:: python

   extensions = ['sphinxcontrib.kana_text']

.. code-block:: python

   #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:

.. code-block:: rst

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

.. code-block:: rst

   .. glossary::

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

And you can also use index/kana role. 

.. code-block:: rst

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

build
-----

finally, build your sphinx project:

.. code-block:: sh

   $ make kana

take a look at genindex.html.

genindex.html
-------------

.. code-block:: sh

   $ 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.


