Skip to content

Commit 7f767fc

Browse files
committed
Relabel as Explanation, add initial paragraph, move weird note::, remove note:: about Sphinx-only
1 parent 6435054 commit 7f767fc

File tree

2 files changed

+8
-10
lines changed

2 files changed

+8
-10
lines changed

docs/user/index.rst

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,7 @@ to help you create fantastic documentation for your project.
7676
:glob:
7777
:caption: Explanation
7878

79+
/localization
7980
/build-notifications
8081
/downloadable-documentation
8182

@@ -233,8 +234,6 @@ out of your documentation and Read the Docs.
233234
flyout-menu
234235
feature-flags
235236

236-
localization
237-
238237
user-defined-redirects
239238
automatic-redirects
240239

docs/user/localization.rst

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,13 @@
11
Localization of Documentation
22
=============================
33

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.
55

66
Read the Docs supports hosting your docs in multiple languages.
77
There are two different things that we support:
88

9-
* A single project written in another language
10-
* A project with translations into multiple languages
11-
9+
.. contents::
10+
:local:
1211

1312
Single project in another language
1413
----------------------------------
@@ -22,10 +21,8 @@ The language will be represented in the URL for your project.
2221
For example,
2322
a project that is in Spanish will have a default URL of ``/es/latest/`` instead of ``/en/latest/``.
2423

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+
-------------------------------------------
2926

3027
This situation is a bit more complicated.
3128
To support this,
@@ -58,3 +55,5 @@ It also gets included in the Read the Docs flyout:
5855
but each project must specify the language to build for those docs.
5956

6057
.. 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

Comments
 (0)