diff options
author | Takeshi KOMIYA <i.tkomiya@gmail.com> | 2020-03-28 16:37:22 +0300 |
---|---|---|
committer | Takeshi KOMIYA <i.tkomiya@gmail.com> | 2020-03-28 16:37:22 +0300 |
commit | bdeea0723bd32c2bfc3883ce7494966a77517c3f (patch) | |
tree | d18a61b4720d7d074ec9ce1c5c6cd9e2def9246e /CONTRIBUTING.rst | |
parent | 2713ada038cd176f87d1d72507ba2f7454b65714 (diff) |
Update CONTRIBUTING
Diffstat (limited to 'CONTRIBUTING.rst')
-rw-r--r-- | CONTRIBUTING.rst | 80 |
1 files changed, 47 insertions, 33 deletions
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index af12e4a5b..c47487139 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -204,6 +204,14 @@ These are the basic steps needed to start developing on Sphinx. #. Wait for a core developer to review your changes. +Translations +~~~~~~~~~~~~ + +The Sphinx core messages and documentations are translated on `Transifex +<https://www.transifex.com/>`_. Please join `Sphinx project on Transifex +<https://www.transifex.com/sphinx-doc/>`_ and translate them. + + Core Developers ~~~~~~~~~~~~~~~ @@ -228,39 +236,6 @@ The following are some general guidelines for core developers: author in the commit message and any relevant :file:`CHANGES` entry. -Locale updates -~~~~~~~~~~~~~~ - -The parts of messages in Sphinx that go into builds are translated into several -locales. The translations are kept as gettext ``.po`` files translated from the -master template ``sphinx/locale/sphinx.pot``. - -Sphinx uses `Babel <http://babel.pocoo.org/en/latest/>`_ to extract messages -and maintain the catalog files. It is integrated in ``setup.py``: - -* Use ``python setup.py extract_messages`` to update the ``.pot`` template. -* Use ``python setup.py update_catalog`` to update all existing language - catalogs in ``sphinx/locale/*/LC_MESSAGES`` with the current messages in the - template file. -* Use ``python setup.py compile_catalog`` to compile the ``.po`` files to binary - ``.mo`` files and ``.js`` files. - -When an updated ``.po`` file is submitted, run compile_catalog to commit both -the source and the compiled catalogs. - -When a new locale is submitted, add a new directory with the ISO 639-1 language -identifier and put ``sphinx.po`` in there. Don't forget to update the possible -values for :confval:`language` in ``doc/usage/configuration.rst``. - -The Sphinx core messages can also be translated on `Transifex -<https://www.transifex.com/>`_. There exists a client tool named ``tx`` in the -Python package "transifex_client", which can be used to pull translations in -``.po`` format from Transifex. To do this, go to ``sphinx/locale`` and then run -``tx pull -f -l LANG`` where LANG is an existing language identifier. It is -good practice to run ``python setup.py update_catalog`` afterwards to make sure -the ``.po`` file has the canonical Babel formatting. - - Coding Guide ------------ @@ -439,3 +414,42 @@ and other ``test_*.py`` files under ``tests`` directory. .. versionadded:: 1.8 Sphinx also runs JavaScript tests. + + +Release procedures +------------------ + +The release procedures are listed on ``utils/release-checklist``. + + +Locale Updates +~~~~~~~~~~~~~~ + +The parts of messages in Sphinx that go into builds are translated into several +locales. The translations are kept as gettext ``.po`` files translated from the +master template :file:`sphinx/locale/sphinx.pot`. + +Sphinx uses `Babel <http://babel.pocoo.org/en/latest/>`_ to extract messages +and maintain the catalog files. It is integrated in ``setup.py``: + +* Use ``python setup.py extract_messages`` to update the ``.pot`` template. +* Use ``python setup.py update_catalog`` to update all existing language + catalogs in ``sphinx/locale/*/LC_MESSAGES`` with the current messages in the + template file. +* Use ``python setup.py compile_catalog`` to compile the ``.po`` files to binary + ``.mo`` files and ``.js`` files. + +When an updated ``.po`` file is submitted, run compile_catalog to commit both +the source and the compiled catalogs. + +When a new locale is submitted, add a new directory with the ISO 639-1 language +identifier and put ``sphinx.po`` in there. Don't forget to update the possible +values for :confval:`language` in ``doc/usage/configuration.rst``. + +The Sphinx core messages can also be translated on `Transifex +<https://www.transifex.com/>`_. There exists a client tool named ``tx`` in the +Python package "transifex_client", which can be used to pull translations in +``.po`` format from Transifex. To do this, go to ``sphinx/locale`` and then run +``tx pull -f -l LANG`` where LANG is an existing language identifier. It is +good practice to run ``python setup.py update_catalog`` afterwards to make sure +the ``.po`` file has the canonical Babel formatting. |