You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/user/localization.rst
+7-8Lines changed: 7 additions & 8 deletions
Original file line number
Diff line number
Diff line change
@@ -1,14 +1,13 @@
1
1
Localization of Documentation
2
2
=============================
3
3
4
-
.. note:: This feature only applies to Sphinx documentation. We are working to bring it to our other documentation backends.
4
+
In this article, we explain high-level approaches to internationalizing and localizing your documentation.
5
5
6
6
Read the Docs supports hosting your docs in multiple languages.
7
7
There are two different things that we support:
8
8
9
-
* A single project written in another language
10
-
* A project with translations into multiple languages
11
-
9
+
.. contents::
10
+
:local:
12
11
13
12
Single project in another language
14
13
----------------------------------
@@ -22,10 +21,8 @@ The language will be represented in the URL for your project.
22
21
For example,
23
22
a project that is in Spanish will have a default URL of ``/es/latest/`` instead of ``/en/latest/``.
24
23
25
-
.. note:: You must commit the ``.po`` files for Read the Docs to translate your documentation.
26
-
27
-
Project with multiple translations
28
-
----------------------------------
24
+
Project with multiple translations (Sphinx)
25
+
-------------------------------------------
29
26
30
27
This situation is a bit more complicated.
31
28
To support this,
@@ -58,3 +55,5 @@ It also gets included in the Read the Docs flyout:
58
55
but each project must specify the language to build for those docs.
59
56
60
57
.. note:: You can read :doc:`guides/manage-translations-sphinx` to understand the whole process for a documentation with multiples languages in the same repository and how to keep the translations updated on time.
58
+
59
+
.. note:: You must commit the ``.po`` files for Read the Docs to translate your documentation.
0 commit comments