sphinx-intl is a utility tool that provides several features that make it easy to translate and to apply translation to Sphinx generated document. Optional: support the Transifex service for translation with Sphinx .

This section describe to translate with Sphinx and sphinx-intl command.

1. Create your document by using Sphinx.

2. Add configurations to your `conf.py`:

   locale_dirs = ['locale/']   #path is example but recommended.
   gettext_compact = False     #optional.

   locale_dirs is required and gettext_compact is optional.

3. Extract document's translatable messages into pot files:

   $ make gettext

4. Setup/Update your `locale_dir`:

   $ sphinx-intl update -p _build/locale -l de -l ja

   Done. You got these directories that contain po files:

   • ./locale/de/LC_MESSAGES/
   • ./locale/ja/LC_MESSAGES/
5. Translate your po files under ./locale/<lang>/LC_MESSAGES/.

6. Build mo files and make translated document:

   $ sphinx-intl build
   $ make -e SPHINXOPTS="-D language='ja'" html

That's all!

• create or update po files from pot files.
• build mo files from po files.

• Python 2.5, 2.6, 2.7, 3.1, 3.2, 3.3, pypy.
• external library: setuptools, six, polib

These features need transifex-client library.

• create .transifexrc file from environment variable, without interactive input.
• create .tx/config file without interactive input.
• update .tx/config file from locale/pot files automatically.
• build mo files from po files in the locale directory.

You need to use tx command for below features:

• tx push -s : push pot (translation catalogs) to transifex.
• tx pull -l ja : pull po (translated catalogs) from transifex.

• Python 2.5, 2.6, 2.7. (transifex-client only support 2.x)
• Your transifex account if you want to download po files from transifex or you want to translate on transifex.
• external library: transifex-client

Recommend strongly: use virtualenv for this procedure:

$ pip install sphinx-intl

If you want to use Optional Features, you need install additional library:

$ pip install sphinx-intl[transifex]

Type sphinx-intl without arguments, options to show command help.

All command-line options can be set with environment variables using the format SPHINXINTL<UPPER_LONG_NAME> . Dashes (-) have to replaced with underscores (_).

For example, to set the languages:

export SPHINXINTL_LANGUAGE=de,ja

This is the same as passing the option to sphinx-intl directly:

sphinx-intl --language=de --language=ja <command>

Add below settings to sphinx document's conf.py if not exists:

locale_dirs = ['locale/']   #for example
gettext_compact = False     #optional

make gettext will generate pot files into _build/locale directory, however pot files should be generated in the locale/pot is convenient. You can be done by replacing _build/locale with locale/pot in your Makefile and/or make.bat that was generated by sphinx-quickstart.

Licensed under the BSD license. See the LICENSE file for specific terms.

This utilty derived from these projects.

• https://bitbucket.org/tk0miya/sphinx-gettext-helper
• https://bitbucket.org/shimizukawa/sphinx-transifex

• Fix: sphinx-intl didn't use SPHINXINTL_CONFIG environment value.
• Feature #3: update-txconfig-resources command now detect project-name from .tx/config that already exists.
• Now using setuptools instead of distribute.
• Fix: tox test raises a error with transifex-client-0.10

• Fix: because --config option did not consider directory path, locale_dir did not contain directory path to conf.py file.

• Add stat command for displaying statistics like 'msgfmt --statistics'.
• Documentation and error messages are improved.
• Fix: update command did not detect pot/po difference when translated count and untranslated count are not difference.

• Add flake8 test and fix some errors.
• Add --pot-dir option. default is pot directory under locale_dir. If you using Sphinx default settings, -p _build/locale is useful.
• Add append/deprecated msgid count information for update command.
• Drop multiple locale directories feature. Now use only first directory of locale_dirs in conf.py.
• Fix: -c option is not working. Thanks @tk0miya!

• First release that provides these commands:
  • update
  • build
  • create-transifexrc
  • create-txconfig
  • update-txconfig-resources