adtzlr / felupe

:mag: finite element analysis for continuum mechanics of solid bodies
https://felupe.readthedocs.io/
GNU General Public License v3.0
61 stars 8 forks source link

🌍Call for translators in FElupe official document🌍 #806

Open tkoyama010 opened 3 days ago

tkoyama010 commented 3 days ago

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:

Language Build Status RTD Project Transifex
English (parent project) Documentation Status readthedocs.org
日本語 Documentation Status readthedocs.org Transifex
tkoyama010 commented 3 days ago

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