Skip to content

Commit 2a09bdd

Browse files
Add an overview of the translation process
1 parent 6f10a40 commit 2a09bdd

2 files changed

Lines changed: 31 additions & 2 deletions

File tree

documentation/translations/overview.svg

Lines changed: 4 additions & 0 deletions
Loading

documentation/translations/translating.rst

Lines changed: 27 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ Translating
66

77
.. highlight:: rest
88

9-
There are several documentation translations already
10-
in production and can be found in the language switcher; others are works in
9+
Several documentation translations are already in production and can be found
10+
in the language switcher; others are works in
1111
progress. To get started read your repository's contributing guide, which is
1212
generally the ``README`` file, and this page.
1313
If your language isn’t listed below, feel free to start the translation!
@@ -133,6 +133,31 @@ For more details about translations and their progress, see
133133
`Transifex <tx_>`_
134134

135135

136+
Overview
137+
========
138+
139+
.. figure:: overview.svg
140+
:align: center
141+
:alt: Strings are extracted from the documentation into PO files,
142+
translated, uploaded to the translation repository, built by
143+
docsbuild-scripts, and published.
144+
145+
.. Drawn with Excalidraw: https://excalidraw.com/#json=BW3zGCjAbXv3-r77UZYwH,7wHyBLCvHV81DexlAiVrHA
146+
147+
Roughly, translation works as follows:
148+
149+
- Translators work on gettext PO file catalogs generated from the Python docs
150+
by Sphinx, rather than editing the documentation directly.
151+
- Teams work in different ways. For example, some have translators work
152+
locally, while others use tools like :ref:`Transifex <transifex-use>`.
153+
Messages without a translation fall back to English, so a translation can be
154+
published before it is complete.
155+
- Translations are committed to the :ref:`translation repository <translation-repo>`.
156+
- Completed translations are automatically pulled in from the repository by
157+
:github:`docsbuild-scripts <python/docsbuild-scripts>` and published to
158+
docs.python.org.
159+
160+
136161
How to get help
137162
===============
138163

0 commit comments

Comments
 (0)