Translating
Skip to content Back to top View this page Edit this page Translating ¶ 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! See coordination to get started.
For more details about translations and their progress, see translations.python.org . Language Coordination team Links Arabic (ar) Abdur-Rahmaan Janhangeer ( @Abdur-rahmaanJ ) GitHub Bengali (bn-IN) Kushal Das ( @kushaldas ) GitHub French (fr) Julien Palard ( @JulienPalard ) AFPy/python-docs-fr , mirror German (de) Swen Bachmann ( @sba72 ) GitHub Greek (el) Lysandros Nikolaou ( @lysnikolaou ), Fanis Petkos ( @thepetk ), Panagiotis Skias ( @skpanagiotis ) GitHub Hindi (hi-IN) Sanyam Khurana ( @CuriousLearner ) GitHub Hungarian (hu) GitHub Indonesian (id) Irvan Putra ( @irvan-putra ), Jeff Jacobson ( @jwjacobson ), Lutfi Zuchri ( @lutfizuchri ) GitHub Italian (it) Alessandro Cucci ( @acuccie3 , email ) GitHub , original announcement Japanese (ja) Kinebuchi Tomohiko ( @cocoatomo ), Atsuo Ishimoto ( @atsuoishimoto ) GitHub Korean (ko) 오동권 ( @flowdas ) GitHub Lithuanian (lt) Albertas Gimbutas ( @albertas , email ) original announcement Marathi (mr) Satvik Mudgal ( @satvikmudgal , email ) GitHub , coordinator transfer Persian (fa) Alireza Shabani ( @revisto ), Sepehr Rasouli ( @sepehr-rs ) GitHub , Telegram Polish (pl) Maciej Olko ( @m-aciek ), Stan Ulbrych ( @StanFromIreland ) GitHub , Transifex , original announcement Brazilian Portuguese (pt-br) Rafael Fontenelle ( @rffontenelle ), Marco Rougeth ( @rougeth ) GitHub , guide , Telegram , article Punjabi (pa) Bhuvansh Kataria ( @BHUVANSH855 ), Mohit Yadav ( @mohityadav8 ), Yashraj Jangra ( @Yashraj-Jangra ) GitHub , Transifex Romanian (ro) Octavian Mustafa ( @octaG-M , email ) GitHub Russian (ru) Daniil Kolesnikov ( @dkqzz , email ) GitHub , Telegram , original announcement Simplified Chinese (zh-cn) Shengjing Zhu ( @zhsj ), Du, Meng ( @dumeng ) GitHub , Transifex Spanish (es) Raúl Cumplido ( @raulcd ) GitHub Swedish (sv) Daniel Nylander ( @yeager ) GitHub Tamil (ta) Murugan Santhosh ( @terminaljoint ), Hari ( @nammahari ) GitHub , Discord Traditional Chinese (zh-tw) 王威翔 Matt Wang ( @mattwang44 ), Josix Wang ( @josix ) GitHub Turkish (tr) Ege Akman ( @egeakman ) GitHub , RTD Ukrainian (uk) Dmytro Kazanzhy ( @kazanzhy , email ) GitHub , Transifex Vietnamese (vi) Duc-Tam Nguyen ( @tamnd ) GitHub , Transifex Overview ¶ 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 Transifex . Messages without a translation fall back to English, so a translation can be published before it is complete. Translations are committed to the translation repository . Completed translations are automatically pulled in from the repository by docsbuild-scripts and published to docs.python.org. Motivation ¶ The Python documentation is written in English, but Python is taught, learned, and used around the world, in many languages.
English is the native language of only about 5% of the world’s population, and fewer than a fifth more speak it as an additional language [ 1 ] . For many people, learning Python also means overcoming a language barrier. They must learn not only Python, but also enough English to be able to use the language’s documentation. The United Nations Open Source Principles call on projects both to provide documentation and to foster inclusive participation [ 2 ] .
Providing documentation only in English limits who can benefit from it and who can participate in the wider Python community. Translations make Python’s documentation accessible to a much wider audience. They allow people to learn and use Python in a language they are confident in, reducing the additional burden of learning through English. Translation also improves the English documentation. Translators review the source text closely and often find bugs.
As a result, translation therefore benefits not only readers of other languages, but everyone who uses and contributes to Python’s documentation. How to get help ¶ If there is already a repository for your language team (there may be links to Telegrams/Discords in the README ), join and introduce yourself. Your fellow translators will be more than happy to help! General discussions about translations occur on the Python Docs Discord #translations channel and the translations category of the Python Discourse.
Style guide ¶ Before translating, you should familiarize yourself with the general documentation style guide . Some translation-specific guidelines are explained below. Translate the meaning ¶ Try to stay as close as possible to the original text. Focus on translating its meaning in the best possible way. Gender neutrality ¶ Many languages use grammatical gender. When possible and natural, prefer gender-neutral or inclusive forms.
Aim to reflect the inclusive tone of the English documentation. Roles and links ¶ The Python docs contain many roles ( :role:`target` ) that link to other parts of the documentation. Do not translate reStructuredText roles targets, such as :func:`print` or :ref:`some-section` because it will break the link. If alternate text ( :role:`text <target>` ) is provided, it generally should be translated. You can also introduce alternate text for translation if the target is not a name or term.
Links ( `text <target>`_ ) should be handled similarly. If possible, the target should be updated to match the language. See also reStructuredText markup Translation quality ¶ Translators should know both English and the language they are translating to. Translators should aim for a similar level of quality as that of the English documentation. Do not rely solely on machine translation. These tools can be useful to speed up work, but often produce inaccurate or misleading results and should be reviewed by a human.
Terminology ¶ The documentation is full of technical terms, some are common in general programming and have translations, whereas others are specific to Python and previous translations are not available. Translation teams should keep the translations of these terms consistent, which is done with glossaries. Some general guidelines for deciding on a translation: Use existing community conventions over inventing new terms.
You can use a hybrid English form if users are generally familiar with the English word. For common terms, the English word may be best. Use other translations as a reference as to what they did for the word. Be careful to not translate names. Use your best judgment. When you translate a specific term, record it in your translations glossary to help fellow translators and ensure consistency. Dialects ¶ Some translations receive contributions from people of several different dialects, understandably the language will differ.
It is recommended however that translators try to keep files and sections consistent. Code examples ¶ Translate values in code examples, that is string literals, and comments. Don’t translate keywords or names, including variable, function, class, argument, and attribute names. An example of a translated codeblock from the tutorial is provided below: def cheeseshop ( kind , * arguments , ** keywords ): print ( "-- Czy jest może" , kind , "?" ) print ( "-- Przykro mi, nie mamy już sera" , kind ) for arg in arguments : print ( arg ) print ( "-" * 40 ) for kw in keywords : print ( kw , ":" , keywords [ kw ]) Transifex ¶ Important There are many translations in the python-doc organization on Transifex , some of which, however, are not used or do not have a coordinati
The rest of this page is on the live site.