Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tkoyama010/cadquery-doc-translations
translated docs for cadquery official document
https://github.com/tkoyama010/cadquery-doc-translations
Last synced: 2 months ago
JSON representation
translated docs for cadquery official document
- Host: GitHub
- URL: https://github.com/tkoyama010/cadquery-doc-translations
- Owner: tkoyama010
- License: apache-2.0
- Created: 2021-05-16T01:39:22.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-10-25T00:05:25.000Z (3 months ago)
- Last Synced: 2024-10-25T05:06:15.027Z (3 months ago)
- Language: Python
- Homepage: https://cadquery-ja.readthedocs.io/ja/latest/
- Size: 18.5 MB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
- awesome-cadquery - cadquery-doc-translations - A repository that holds Japanese translations of the CadQuery docs. (Miscellaneous)
README
# cadquery on the Read The Docs.
translated docs for cadquery official document
This is a project to provide cadquery 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.
## 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.
| Language | Build Status | RTD Project | Transifex |
| :----------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- |
| English (parent project) | [](https://cadquery.readthedocs.io/en/latest/?badge=latest) | [](https://readthedocs.org/projects/cadquery/) | |
| 日本語 | [](https://cadquery-ja.readthedocs.io/ja/latest/?badge=latest) | [](https://readthedocs.org/projects/cadquery-ja/) | [](https://app.transifex.com/tkoyama010/cadquery-doc/translate/#/ja) |
## 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/cadquery-ja/
5. add translation project to parent project like:
https://readthedocs.org/dashboard/cadquery/translations/