Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: rephrase multiple i18n support #10581

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

docs: rephrase multiple i18n support #10581

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
60e4575
docs: rephrase multiple i18n support
12rambau Jul 29, 2023
f0f5d83
refactor: typo
12rambau Jul 29, 2023
03618ec
fix: rollback to original package-lock
12rambau Jul 29, 2023
c79b2de
refactor: fix indetnation warnings
12rambau Jul 29, 2023
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
41 changes: 21 additions & 20 deletions docs/user/localization.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,29 +37,30 @@ Projects with multiple translations (Sphinx-only)
.. seealso::

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

This situation is a bit more complicated.
To support this,
you will have one parent project and a number of projects marked as translations of that parent.
Let's use ``phpmyadmin`` as an example.

The main ``phpmyadmin`` project is the parent for all translations.
Then you must create a project for each translation,
for example ``phpmyadmin-spanish``.
You will set the *Language* for ``phpmyadmin-spanish`` to ``Spanish``.
In the parent projects *Translations* page,
you will say that ``phpmyadmin-spanish`` is a translation for your project.

This has the results of serving:

* ``phpmyadmin`` at ``http://phpmyadmin.readthedocs.io/en/latest/``
* ``phpmyadmin-spanish`` at ``http://phpmyadmin.readthedocs.io/es/latest/``

It also gets included in the Read the Docs :term:`flyout menu`:
Describes the whole process for a documentation with multiples languages in
the same repository and how to keep the translations updated on time.

By design each ReadTheDocs project can only be build in one language. In order to support
multiple transaltion of the same doc you need to follow these 2 steps:
- Create a project for each translation. For example, if you have a project called
``myproject`` using ``English`` language, and you want to translate it to *Spanish*,
you need to create a new project called ``myproject-spanish`` and set the language
to ``Spanish``.
- To connect all these projects together choose one of them as the parent project,
in our case ``myproject``. In the *admin* section go to *Translation* and select
the translated projects in the dropdown, in this case ``myproject-spannish``.

As a consequence, the translated project will be served at
``https://myproject.readthedocs.io/es/latest/`` instead of
``https:://myproject-spannish.readthedocs.io/es/latest/``. It will appear in the
*Translation* section of the parent project and the *Translation* section of the ``myproject-spannish`` project will be disabled. Finally the tranlation will be
included in the Read the Docs :term:`flyout menu`:

.. image:: /img/translation_bar.png

.. note::
You can add as many tranlation as you want to a parent project.

.. note::
The default language of a custom domain is determined by the language of the
parent project that the domain was configured on. See
Expand Down