How to use

This extension depends on the versions of Sphinx, docutils and Python. Check first Changes History . If you have the different version of them, you might (or might not) fix the extensions.

• Make sure the encoding used in logging
  • (All contents on this page below might be obsolete.)
  • Using sitecustomize.py
  • Using the patch for Sphinx
• unicode_ids.py extension
• user_ordered_index_patch.py
  • Declare to use as the extension
  • Make sure the language of your document
  • Make sure sort_order.py and sort_order_xx.py exists
    • Make sort_order_xx.py where xx is your locale
    • Directly assigning sort order
• Yogosyu directive
  • Declare to use as the extension
  • Define and assign the sort order for your language
  • Use yogosyu directive instead of glossary
  • Assign yomimark option
  • Add yomimark and Yomigana after terms

Note

Japanese version of this document uses different way to describe usage, because yomigana feature installed within yogosyu.py is REQUIRED to sort Japanese words.

But for many languages used in Europe don’t have to use yomigana, so that the description of user_ordered_index_patch.py first and yogosyu.py later. In Japanese version, yogosyu.py goes first.