sphinx-intl 0.9.6

Requirements for basic

• Python 2.5, 2.6, 2.7, 3.1, 3.2, 3.3, 3.4, pypy.

• external library: setuptools, six, polib, click

Requirements for optional

• 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

Commands

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

Setup environment variables

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>

Setup sphinx conf.py

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

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

Setup Makefile / make.bat

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.

0.9.6 (2015/09/22)

• PR#6: Fix update_txconfig_resources command raise errors with pot filename including symbols and spaces. Thanks to Takeshi Komiya.

• PR#7: Fix sphinx-intl could not find conf.py in projects separating build and source directories. Thanks to Takeshi Komiya.

• PR#8: Detects pot_dir automatically if sphinx has generated. Thanks to Takeshi Komiya.

• PR#9: Support fuzzy translations. Thanks to Guilherme Brondani Torri.

• PR#10: Add __file__ to conf.py’s namespace.

• On Windows environment, now using “transifex<0.9” because “transifex>=0.9” requires unnecessary py2exe installation.

0.9.5 (2014/07/10)

• Fix: PR#2, PR#4: update-txconfig-resources disregarded –pot-dir option. Thanks to Giacomo Spettoli, Takeshi Komiya.

• Fix: PR#5: update-txconfig-resources command raise errors when project name includes spaces and dots. Thanks to Takeshi Komiya.

• PR#3: Skip building process if mo file is newer than po file. Thanks to Nozomu Kaneko.

• Add supporting Python-3.4

0.9.4 (2013/12/10)

• 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

0.9.3 (2013/04/20)

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

0.9.2 (2013/4/11)

• 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.

0.9.1 (2013/4/10)

• 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!

0.9.0 (2013/4/7)

• First release that provides these commands:

  • update

  • build

  • create-transifexrc

  • create-txconfig

  • update-txconfig-resources