@@ -280,15 +280,34 @@ To do so, use `sphinx-autobuild`_ to run the following command:
280280 .. _sphinx-autobuild : https://github.com/sphinx-doc/sphinx-autobuild
281281
282282Translations
283- ~~~~~~~~~~~~
283+ ------------
284284
285285The parts of messages in Sphinx that go into builds are translated into several
286286locales. The translations are kept as gettext ``.po `` files translated from the
287287master template :file: `sphinx/locale/sphinx.pot `.
288288
289+ These Sphinx core messages are translated using the online `Transifex
290+ <https://explore.transifex.com/sphinx-doc/sphinx-1/> `__ platform.
291+
292+ Translated strings from the platform are pulled into the Sphinx repository
293+ by a maintainer before a new release.
294+
295+ We do not accept pull requests altering the translation files directly.
296+ Instead, please contribute translations via the Transifex platform.
297+
298+ Translations notes for maintainers
299+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
300+
301+ The `transifex CLI <https://developers.transifex.com/docs/cli >`__ (``tx ``)
302+ can be used to pull translations in ``.po `` format from Transifex.
303+ To do this, go to :file: `sphinx/locale ` and then run ``tx pull -f -l LANG ``
304+ where ``LANG `` is an existing language identifier.
305+ It is good practice to run ``python utils/babel_runner.py update `` afterwards
306+ to make sure the ``.po `` file has the canonical Babel formatting.
307+
289308Sphinx uses `Babel <https://babel.pocoo.org/en/latest/ >`_ to extract messages
290309and maintain the catalog files. The :file: `utils ` directory contains a helper
291- script, `` babel_runner.py ` `.
310+ script, :file: ` utils/ babel_runner.py `.
292311
293312* Use ``python babel_runner.py extract `` to update the ``.pot `` template.
294313* Use ``python babel_runner.py update `` to update all existing language
@@ -301,19 +320,10 @@ When an updated ``.po`` file is submitted, run
301320``python babel_runner.py compile `` to commit both the source and the compiled
302321catalogs.
303322
304- When a new locale is submitted , add a new directory with the ISO 639-1 language
323+ When a new locale is added , add a new directory with the ISO 639-1 language
305324identifier and put ``sphinx.po `` in there. Don't forget to update the possible
306325values for :confval: `language ` in :file: `doc/usage/configuration.rst `.
307326
308- The Sphinx core messages can also be translated on `Transifex
309- <https://www.transifex.com/sphinx-doc/sphinx-1/> `_. There ``tx `` client tool,
310- which is provided by the ``transifex_client `` Python package, can be used to
311- pull translations in ``.po `` format from Transifex. To do this, go to
312- :file: `sphinx/locale ` and then run ``tx pull -f -l LANG `` where ``LANG `` is an
313- existing language identifier. It is good practice to run
314- ``python babel_runner.py update `` afterwards to make sure the ``.po `` file has the
315- canonical Babel formatting.
316-
317327
318328Debugging tips
319329--------------
0 commit comments