https://github.com/tkoyama010/cofea-doc-translations

translated docs for CoFEA official document
https://github.com/tkoyama010/cofea-doc-translations

language po-files rtd sphinx

Last synced: 7 months ago
JSON representation

translated docs for CoFEA official document

• Host: GitHub
• URL: https://github.com/tkoyama010/cofea-doc-translations
• Owner: tkoyama010
• License: other
• Created: 2021-05-14T10:12:31.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2025-03-31T18:05:54.000Z (7 months ago)
• Last Synced: 2025-03-31T19:24:12.745Z (7 months ago)
• Topics: language, po-files, rtd, sphinx
• Language: Python
• Homepage: https://cofea-ja.readthedocs.io/ja/latest/
• Size: 6.64 MB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          
# CoFEA on the Read The Docs.

translated docs for CoFEA official document

|         | :globe_with_meridians:                                                                                                                              |

| ------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |

| English | [![Documentation Status](https://readthedocs.org/projects/cofea/badge/?version=latest)](https://cofea.readthedocs.io/en/latest/?badge=latest)       |

| 日本語  | [![Documentation Status](https://readthedocs.org/projects/cofea-ja/badge/?version=latest)](https://cofea-ja.readthedocs.io/ja/latest/?badge=latest) |

[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg)](CODE_OF_CONDUCT.md)

![license](https://licensebuttons.net/l/by-nc-sa/4.0/88x31.png)

This is a project to provide cofea 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/cofea/ (Master)

  - https://readthedocs.org/projects/cofea-ja/

- Documentation pages for each languages:

  - https://cofea.readthedocs.io/en/latest/

  - https://cofea-ja.readthedocs.io/ja/latest/

## 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

```

sh ./locale/update.sh

```

After that, you should commit updated po files.

## How to add a language

1. add language to locale/update.sh:

   ```

   - rm -R ja

   - tx pull -l ja

   + rm -R ja de

   + tx pull -l ja,de

   ```

2. update po files

3. commit them

4. add new project on Read The Docs like:

   https://readthedocs.org/projects/cofea-ja/

5. add translation project to parent project like:

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