sphinx-doc/sphinx-doc-translations

Name: sphinx-doc-translations

Owner: sphinx-doc

Description: translated docs for sphinx official document

Created: 2016-01-08 23:41:27.0

Updated: 2018-05-24 15:45:36.0

Pushed: 2018-05-24 15:45:33.0

Homepage: null

Size: 48528

Language: Shell

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

sphinx-doc.org on the Read The Docs.

This is a project to provide Sphinx official documentation with multiple versions and multiple languages on Read The Docs site.

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 sphinx-build command. Unfortunately Read the Docs can't. If there are any better way, please let me know.

URLs

• RTD project pages for Sphinx:

• https://readthedocs.org/projects/sphinx/ (Master)

• https://readthedocs.org/projects/sphinx-ja/

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

• https://readthedocs.org/projects/sphinx-es/

• Documentation pages for each languages:

• http://www.sphinx-doc.org/

• http://www.sphinx-doc.org/ja

• http://www.sphinx-doc.org/pt_BR

• http://www.sphinx-doc.org/es

How to setup a translated documentation project on RTD

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

Points are:

• We must have RTD projects for each languages.
• Each projects must have correct Language setting on “Settings” page.
• Master project has connections to each translated projects on “translations settings” page.

How to update po files

/locale/update.sh

After that, you should commit updated po files.

How to add a language

1. add language to locale/update.sh:

2. rm -R es ja

3. tx pull -l es,ja

4. rm -R es ja pt_BR

5. tx pull -l es,ja,pt_BR

6. update po files

7. commit them

8. add new project on Read The Docs like:

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

9. add translation project to parent project like:

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

How to add a new version

1. add tag 1.7

   tag 1.7
   

2. replace old version 1_7 with 1_8 in:

3. release.sh

4. .travis.yml

5. commit it and push them:

   add release.sh .travis.yml
   commit -m "add new version: 1.8"
   push --tags
   

6. enable version 1.7 on RTD:

   https://readthedocs.org/dashboard/sphinx-ja/versions/