Sphinx utility that make it easy to translate and to apply translation.
Project description
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 .
QuickStart for sphinx translation
This section describe to translate with Sphinx and sphinx-intl command.
Create your document by using Sphinx.
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.
Extract document’s translatable messages into pot files:
$ make gettext
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/pot/
./locale/de/LC_MESSAGES/
./locale/ja/LC_MESSAGES/
Translate your po files under ./locale/<lang>/LC_MESSAGES/.
Build mo files and make translated document:
$ sphinx-intl build $ make -e SPHINXOPTS="-D language='ja'" html
That’s all!
Basic Features
create or update po files from pot files.
build mo files from po files.
Requirements for basic
Python 2.5, 2.6, 2.7, 3.1, 3.2, 3.3.
external library: distribute, six, polib
Optional features
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.
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
Installation
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]
Commands, options, environment variables
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.
License
Licensed under the BSD license. See the LICENSE file for specific terms.
Original
This utilty derived from these projects.
CHANGES
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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
File details
Details for the file sphinx-intl-0.9.2.tar.gz.
File metadata
- Download URL: sphinx-intl-0.9.2.tar.gz
- Upload date:
- Size: 11.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | a6598b26f0d367ab12b36447cd84926bc6e8332c98211c05b9c3dc4634263fad |
|
| MD5 | 16920f4e7636de673ad8cd832a16917f |
|
| BLAKE2b-256 | 73e6898c6f1866f2894b01a02fd0da8fc2f6c4fe9a3c37d92ecaa9fb9d9ef214 |
