Introduction

Sphinx is one of good solutions to make our documentations easier. It can treat non-English language, but some important features are not implemented.

  • Sphinx can’t use native language to name files and anchors in the HTML output.
  • Sphinx can’t group the terms in index, except the case that the documents are written in English.
    • All non-English characters goes to group Symbols.
  • Sphinx can’t sort the terms that can’t be written in English.
    • Sphinx convert the terms with Unicode NFD method before sorting, but NFD or other canonical methods can’t be used to sort.
    • In some language, like Japanese, the terms can’t be sorted without Yomigana. But there’s no way to give it.

If you want the sort key feature like MediaWiki(Wikipedia like), this extension will give you functionality.

This work tries to solve the problems above. You can use this work under the BSD License but if you feel the work nice, please donate !