ドキュメントの翻訳

このドキュメントは例としてロシア語への変換を使用します。他の言語については、ru を適切な言語コードに置き換えてください。

翻訳環境のセットアップ

標準のpython-sphinx ツールに加えて、変換のために必要とされるファイルを構築するためにsphinx-intl ツールが必要です。インストールするためにこのコマンドを実行します:

$ sudo pip install sphinx-intl

翻訳可能なメッセージはgettextを使って抽出されます:

$ make gettext

これらはローカルファイルを言語ファイルを更新するために使われなければなりません:

$ sphinx-intl update -p build/locale -c source/conf.py -l ru

翻訳ファイル

上のように一旦更新すると、source/locale/ru/LC_MESSAGESの中に変換ソースファイルを見つけることができます。.po 拡張子を持つ各ファイルには、msgid および msgstrと呼ばれるエントリーがあります。msgid contains the English and msgstr is where to put the translation. もっと多くの内容が必要な場合、各エントリーは元となるソースファイルと行を言及するでしょう。

コミットする時には、翻訳がソースと一緒に格納されるように、.po ファイルがGitHubに追加されなければなりません。

翻訳のテスト

Wikiの翻訳バージョンは以下を使って構築されます:

$ sphinx-intl build -c source/conf.py
$ make -e SPHINXOPTS="-D language='ru'" html

変換された出力は build/htmlに書き込まれます。