拡張モジュールの配置と指定

この配布物の ext フォルダに含まれる各種 *.py を Sphinx から参照できるようにします。

sort_order.py や sort_order_ja.py などは通常間接的に指定することになりますので、 extensions 変数の中には記述しない点にご注意下さい。

一般的な方法としては次のような形になります。

複製と配置

1. 各自のプロジェクトでお使いの _template, _statics に並置されるように exts フォルダをまるごと複写する。

2. conf.py の最初の方でそのフォルダを参照先に加える:

   sys.path.insert(0, os.path.abspath('exts'))
   

3. conf.py の extension変数に sort_order(_xx).py 以外を指定する:

   extensions = ['unicode_ids',
                 'user_ordered_index_patch',
                 'yogosyu',
                ]
   

4. conf.py の language 変数に 'ja' を指定する:

   language = 'ja'
   

language 変数に指定した値 'xx' を元に自動的に sort_order_xx.py が選択される仕組みになっています。 xx の部分は多くの場合二文字ですが五文字のものでも差し支えありません。

あえて自動選択とは違う並び順を指定したい場合に限り extensions 変数において user_ordered_inedx_patch や yogosyu より前に当該モジュール名を指定してください。