Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions documentation/translations/overview.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
29 changes: 27 additions & 2 deletions documentation/translations/translating.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ Translating

.. highlight:: rest

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


Overview
========

.. figure:: overview.svg
:align: center
:alt: Strings are extracted from the documentation into PO files,
translated, uploaded to the translation repository, built by
docsbuild-scripts, and published.

.. Drawn with Excalidraw: https://excalidraw.com/#json=BW3zGCjAbXv3-r77UZYwH,7wHyBLCvHV81DexlAiVrHA

Roughly, translation works as follows:

- Translators work on gettext PO file catalogs generated from the Python docs
by Sphinx, rather than editing the documentation directly.
- Teams work in different ways. For example, some have translators work
locally, while others use tools like :ref:`Transifex <transifex-use>`.
Messages without a translation fall back to English, so a translation can be
published before it is complete.
- Translations are committed to the :ref:`translation repository <translation-repo>`.
- Completed translations are automatically pulled in from the repository by
:github:`docsbuild-scripts <python/docsbuild-scripts>` and published to
docs.python.org.


How to get help
===============

Expand Down
Loading