sortorder 2.0.6

介绍

目前，2015 年 6 月 1 日，Sphinx 1.3.1 无法在索引页面和词汇表指令中生成本地化标题。这个包使狮身人面像国际化的大门。这意味着需要另一个包，我将制作一个名为“Gosyu”的包，请在 pip 上找到。

这个包不依赖于 Sphinx。您可以将其用于其他文本处理产品。

执照

2-clause BSD，与 Sphinx 项目相同。

安装

你可以像其他 Python 包一样安装或卸载这个包。此外，您可以在 Python 系统上不安装此包的情况下使用此包，Sphinx 的配置文件（conf.py）使您可以使用。

如何使用（与狮身人面像）

要了解如何使用已有的排序顺序，请参阅yogosyu或gosyu。

如果您想使用此包具有的预设排序顺序之一，只需 language = 'xx'. 它会导致自动加载sortorder.xx。

目前，可用xx、ja和用于 预设。eoelru

要了解如何制作自己的排序顺序，请参阅sortorder/__init__.py。

简而言之：

• 确定新模块的文件名并创建它。如果你命名sort_order_xx.pylanguage = 'xx' ，它会在声明时自动加载。

• 写import sortorder。

• 使类继承sortorder.SortOrderBase。

• 覆盖get_string_to_sort和get_group_name。

• makeget_default_sort_order返回类的实例。

• 使setup. 请参阅任何包含此包的sortorder.xx 。

使用方法（一般）

如果您没有通过 pip 安装此模块，则应首先执行 sys.path.insert(0, '<the_folder_you_copied_the_extension_file>').

其次，如果您想直接使用ja.py（日语）、eo.py（世界语）、 el.py（希腊语）或ru.py（俄语），只需执行语言代码的位置，如import sortorder.xxx ,等。xxxjaeo

否则，您应该根据需要制作排序顺序模块。您应该定义继承的新类 sortorder.SortOrderBase。模块的文件名应以 为前缀sort_order_，如sort_order_xx.py。

get_default_sort_order和setup方法仅由 Sphinx 文档生成器使用。

在你制作sort_order_xx.py或有人给它之后，将 .py 文件的路径添加到sys.path上面一样。接下来导入模块：

sys.path.insert(0, '<the_folder_you_copied_the_extension_file>')
# (snip...)
import sort_order_xx # may automatically import sortorder.__init__.py

但是sortorder.__init__有方法get_sort_order。get_default_sort_order通过在模块中定义方法，您可以为代码添加一些自动功能，例如与 Sphinx 一起使用的功能。

作者

铃见咲君高，2011-2015

历史

2.0.6（2015-07-04）：

修复 PyPI 的文档（此文件）。

2.0.5（2015-07-04）：

• yogosyu扩展的一部分。

• 首先上传到 PyPI。

2013-12-07：

添加 Python 3 支持。

2013-12-06：

更新以满足 Sphinx 1.2。

2011-06-28：

添加了俄语和希腊语版本。

2011-05-24：

第一次发布。包含在yogosyu扩展中。包括日语和世界语版本。