Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

🌍Call for translators in FElupe official document🌍 #806

Open
tkoyama010 opened this issue Jul 3, 2024 · 3 comments
Open

🌍Call for translators in FElupe official document🌍 #806

tkoyama010 opened this issue Jul 3, 2024 · 3 comments
Labels
documentation Improvements or additions to documentation

Comments

@tkoyama010
Copy link
Contributor

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) Documentation Status readthedocs.org
日本語 Documentation Status readthedocs.org Transifex
@tkoyama010
Copy link
Contributor Author

@adtzlr I can setup Japanese translated documentation on RTD. Please add me maintainer on readthedocs.org if you like this.

@adtzlr
Copy link
Owner

adtzlr commented Jul 27, 2024

Hi @tkoyama010,

this is fantastic, thanks! Sorry for the super-late reply, I'm taking a break during the summer months except for some minimal-work on FElupe which is absolutely needed for my scientific interests.

Is this auto-translated from / auto-synced to the original english documentation? What is the benefit vs. Chrome built-in translations?

(the above mentioned issue is not related to this issue, but I can't remove the reference, sorry)

@adtzlr adtzlr added the documentation Improvements or additions to documentation label Jul 27, 2024
@tkoyama010
Copy link
Contributor Author

Hi @tkoyama010,

this is fantastic, thanks! Sorry for the super-late reply, I'm taking a break during the summer months except for some minimal-work on FElupe which is absolutely needed for my scientific interests.

Is this auto-translated from / auto-synced to the original english documentation? What is the benefit vs. Chrome built-in translations?

(the above mentioned issue is not related to this issue, but I can't remove the reference, sorry)

Thanks for your reply :) I am translating this while reading the document. With Chrome's automatic translation, there is no way to fix a mistranslation, but with this method, Transifex can suggest the correct translation. This proposal is following Python's PEP 545 – Python Documentation Translations.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants