IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Update documentation

Browse Source
This commit is contained in:
Adam Turner 2022-04-16 20:58:59 +01:00
parent 0db2817328
commit 22f7a0124c
1 changed files with 11 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
doc/internals/contributing.rst
View File

@ -252,17 +252,19 @@ locales. The translations are kept as gettext ``.po`` files translated from the
master template :file:`sphinx/locale/sphinx.pot`. master template :file:`sphinx/locale/sphinx.pot`.
Sphinx uses `Babel <https://babel.pocoo.org/en/latest/>`_ to extract messages Sphinx uses `Babel <https://babel.pocoo.org/en/latest/>`_ to extract messages
and maintain the catalog files. It is integrated in ``setup.py``: and maintain the catalog files. The ``utils`` directory contains a helper
script, ``babel_runner.py``.
* Use ``python setup.py extract_messages`` to update the ``.pot`` template. * Use ``python babel_runner.py extract`` to update the ``.pot`` template.
* Use ``python setup.py update_catalog`` to update all existing language * Use ``python babel_runner.py update`` to update all existing language
catalogs in ``sphinx/locale/*/LC_MESSAGES`` with the current messages in the catalogs in ``sphinx/locale/*/LC_MESSAGES`` with the current messages in the
template file. template file.
* Use ``python setup.py compile_catalog`` to compile the ``.po`` files to binary * Use ``python babel_runner.py compile`` to compile the ``.po`` files to binary
``.mo`` files and ``.js`` files. ``.mo`` files and ``.js`` files.
When an updated ``.po`` file is submitted, run compile_catalog to commit both When an updated ``.po`` file is submitted, run
the source and the compiled catalogs. ``python babel_runner.py compile`` 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 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 identifier and put ``sphinx.po`` in there. Don't forget to update the possible
@ -273,9 +275,9 @@ The Sphinx core messages can also be translated on `Transifex
which is provided by the ``transifex_client`` Python package, can be used to which is provided by the ``transifex_client`` Python package, can be used to
pull translations in ``.po`` format from Transifex. To do this, go 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 ``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 existing language identifier. It is good practice to run
update_catalog`` afterwards to make sure the ``.po`` file has the canonical ``python babel_runner.py update`` afterwards to make sure the ``.po`` file has the
Babel formatting. canonical Babel formatting.
Debugging tips Debugging tips