Skip to content

Latest commit

 

History

History
132 lines (108 loc) · 5.85 KB

README.rst

File metadata and controls

132 lines (108 loc) · 5.85 KB
Raw

Sphinx official documentation translations

Badge for the update status Badge for the translation tests

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

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
Documentation Status http://www.sphinx-doc.org/en https://readthedocs.org/projects/sphinx/ (Parent project)
Documentation Status http://www.sphinx-doc.org/ar https://readthedocs.org/projects/sphinx-ar/
Documentation Status http://www.sphinx-doc.org/ca https://readthedocs.org/projects/sphinx-ca-es/
Documentation Status http://www.sphinx-doc.org/zh-cn https://readthedocs.org/projects/sphinx-zh-cn/
Documentation Status http://www.sphinx-doc.org/fr https://readthedocs.org/projects/sphinx-fr/
Documentation Status http://www.sphinx-doc.org/de https://readthedocs.org/projects/sphinx-de/
Documentation Status http://www.sphinx-doc.org/it https://readthedocs.org/projects/sphinx-it-it/
Documentation Status http://www.sphinx-doc.org/ja https://readthedocs.org/projects/sphinx-ja/
Documentation Status http://www.sphinx-doc.org/ko https://readthedocs.org/projects/sphinx-ko/
Documentation Status http://www.sphinx-doc.org/pl https://readthedocs.org/projects/sphinx-pl-pl/
Documentation Status http://www.sphinx-doc.org/pt-br https://readthedocs.org/projects/sphinx-pt-br/
Documentation Status http://www.sphinx-doc.org/ru https://readthedocs.org/projects/sphinx-doc-ru/
Documentation Status http://www.sphinx-doc.org/sr https://readthedocs.org/projects/sphinx-sr/
Documentation Status http://www.sphinx-doc.org/es https://readthedocs.org/projects/sphinx-es/

How to add a new language translation

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

    - LANGS='es ja'
+ LANGS='es ja pt_BR'

  2. Update po files:

    sh ./locales/update.sh

  1. Commit them

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

  1. Add new translation project to parent project:

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