Skip to content

Commit 65c3a2c

Browse files
humitosagjohnson
andauthored
Docs: make translation section more generic (#11549)
* Docs: make translation section more generic - Remove the "Sphinx-only" part since there wasn't almost anything related to Sphinx - Use `godot` as example since it's a more maintained project with lot of translations - Update the note to mention that guide is for Sphinx only projects. Reference: #11538 * Update docs/user/localization.rst Co-authored-by: Anthony <[email protected]> --------- Co-authored-by: Anthony <[email protected]>
1 parent 8e71d96 commit 65c3a2c

File tree

2 files changed

+17
-20
lines changed

2 files changed

+17
-20
lines changed

docs/user/img/translation_bar.png

18.6 KB
Loading

docs/user/localization.rst

Lines changed: 17 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -31,24 +31,30 @@ The language will be represented in the URL for your project.
3131
For example,
3232
a project that is in Spanish will have a default URL of ``/es/latest/`` instead of ``/en/latest/``.
3333

34-
Projects with multiple translations (Sphinx-only)
35-
-------------------------------------------------
34+
Projects with multiple translations
35+
-----------------------------------
3636

3737
.. seealso::
3838

3939
:doc:`guides/manage-translations-sphinx`
40-
Describes the whole process for a documentation with multiples languages in the same repository and how to keep the translations updated on time.
40+
Describes the whole process for a Sphinx documentation projects with multiples languages
41+
in the same repository and how to keep the translations updated on time.
4142

42-
This situation is a bit more complicated. Each language must have its own project. You will choose one to be the parent project, and add each of the other projects as "Translations" of the parent project.
43+
Each language must have its own project on Read the Docs.
44+
You will choose one to be the parent project,
45+
and add each of the other projects as "Translations" of the parent project.
4346

44-
Let's use ``phpmyadmin`` as an example.
47+
Let's use ``godot`` as an example.
4548

46-
The ``phpmyadmin`` project is the parent. Each translation then has its own project, for example ``phpmyadmin-spanish``. The *Language* for ``phpmyadmin-spanish`` is set to ``Spanish``. Then, on the *Translations* page of the ``phpmyadmin`` project, ``phpmyadmin-spanish`` is set as translation.
49+
The ``godot`` project is the parent.
50+
Each translation then has its own project, for example ``godot-es``.
51+
The *Language* for ``godot-es`` is set to ``Spanish``.
52+
Then, on the *Translations* page of the ``godot`` project, ``godot-es`` is set as translation.
4753

4854
This has the results of serving:
4955

50-
* ``phpmyadmin`` at ``https://phpmyadmin.readthedocs.io/en/latest/``
51-
* ``phpmyadmin-spanish`` at ``https://phpmyadmin.readthedocs.io/es/latest/``
56+
* ``godot`` at ``https://docs.godotengine.org/en/stable/``
57+
* ``godot-es`` at ``https://docs.godotengine.org/es/stable/``
5258

5359
It also gets included in the Read the Docs :term:`flyout menu`:
5460

@@ -59,12 +65,6 @@ It also gets included in the Read the Docs :term:`flyout menu`:
5965
parent project that the domain was configured on. See
6066
:doc:`/custom-domains` for more information.
6167

62-
.. note:: You can include multiple translations in the same repository,
63-
with same ``conf.py`` and ``.rst`` files,
64-
but each project must specify the language to build for those docs.
65-
66-
.. note:: You must commit the ``.po`` files for Read the Docs to translate your documentation.
67-
6868

6969
Translation workflows
7070
~~~~~~~~~~~~~~~~~~~~~
@@ -74,23 +74,20 @@ the workflow of your translators becomes a critical component.
7474

7575
Considerations include:
7676

77-
* Are your translators able to use a git workflow? For instance, are they able to translate directly via GitHub?
77+
* Are your translators able to use a Git workflow? For instance, are they able to translate directly via GitHub?
7878
* Do you benefit from machine translation?
7979
* Do you need different roles, for instance do you need translators and editors?
8080
* What is your source language?
8181
* When are your translated versions published?
8282

83-
By using Sphinx and .po files,
84-
you will be able to automatically synchronize between your documentation source messages on your git platform and your translation platform.
85-
8683
There are many translation platforms that support this workflow.
8784
These include:
8885

8986
* `Weblate <https://weblate.org/>`_
9087
* `Transifex <https://www.transifex.com/>`_
9188
* `Crowdin <https://crowdin.com/>`_
9289

93-
Because Read the Docs builds your git repository,
90+
Because Read the Docs builds your Git repository,
9491
you can use any of the above solutions.
95-
Any solution that synchronizes your translations with your git repository
92+
Any solution that synchronizes your translations with your Git repository
9693
will ensure that your translations are automatically published with Read the Docs.

0 commit comments

Comments
 (0)