Sphinx official documentation translations

This is a project to provide Sphinx official documentation, hosted on the Read The Docs platform, in multiple languages.

Note

The current procedure is bit tricky because Read The Docs doesn't have a way to specify options for sphinx-build command. conf.py files for each languages have language and locale_dirs values without having full copy of conf.py of sphinx doc. If we want to specify conf.py file that is out of source directory, we will use -c option for the sphinx-build command. Unfortunately Read the Docs doesn't support that. If there is a better way, open an issue.

How the translated documentation projects are setup on RTD

Instructions: https://docs.readthedocs.org/en/latest/localization.html#project-with-multiple-translations

Key points:

• There is a RTD project for each language.
• Each project needs the correct Language setting on the Settings page.
• The parent project needs connections created to each translated project on the Translations Settings page.

Build Status	sphinx-doc docs	RTD Project
	http://www.sphinx-doc.org/en	https://readthedocs.org/projects/sphinx/ (Parent project)
	http://www.sphinx-doc.org/ar	https://readthedocs.org/projects/sphinx-ar/
	http://www.sphinx-doc.org/ca	https://readthedocs.org/projects/sphinx-ca-es/
	http://www.sphinx-doc.org/zh-cn	https://readthedocs.org/projects/sphinx-zh-cn/
	http://www.sphinx-doc.org/fr	https://readthedocs.org/projects/sphinx-fr/
	http://www.sphinx-doc.org/de	https://readthedocs.org/projects/sphinx-de/
	http://www.sphinx-doc.org/it	https://readthedocs.org/projects/sphinx-it-it/
	http://www.sphinx-doc.org/ja	https://readthedocs.org/projects/sphinx-ja/
	http://www.sphinx-doc.org/ko	https://readthedocs.org/projects/sphinx-ko/
	http://www.sphinx-doc.org/pl	https://readthedocs.org/projects/sphinx-pl-pl/
	http://www.sphinx-doc.org/pt-br	https://readthedocs.org/projects/sphinx-pt-br/
	http://www.sphinx-doc.org/ru	https://readthedocs.org/projects/sphinx-doc-ru/
	http://www.sphinx-doc.org/sr	https://readthedocs.org/projects/sphinx-sr/
	http://www.sphinx-doc.org/es	https://readthedocs.org/projects/sphinx-es/

How to add a new language translation

1. Add new language to locale/update.sh:

   - rm -R es ja
   - tx pull -l es,ja
   + rm -R es ja pt_BR
   + tx pull -l es,ja,pt_BR

2. Update po files:

   sh ./locale/update.sh

3. Commit them

4. Add new project on Read The Docs. For example, for pt_BR:

   https://readthedocs.org/projects/sphinx-pt-br/

   Note

   If a RTD project name for a translation is already taken, create a unique project name instead. For example, when sphinx-ru was taken, sphinx-doc-ru was used instead.

5. Add new translation project to parent project:

   https://readthedocs.org/dashboard/sphinx/translations/