-
Notifications
You must be signed in to change notification settings - Fork 17
Description
If you've ever wanted to contribute and help the cause of open source, now is your chance. We need you!
FElupe documentation translations is a project to provide FElupe 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 felupe 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.
| Language | Build Status | RTD Project | Transifex |
|---|---|---|---|
| English (parent project) | |||
| 日本語 |