Skip to content

project to provide Getfem official documentation with multiple versions and multiple languages on Read The Docs

License

Notifications You must be signed in to change notification settings

getfem-doc/getfem-doc-translations

Repository files navigation

getfem-doc.org on the Read The Docs.

getfem-auto-update License: LGPL v3 GitHub issues GitHub contributors Contributor Covenant pre-commit.ci status code style: prettier

This is a project to provide Getfem 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 getfem 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.

This repository is inspired by sphinx-doc/sphinx-doc-translations.

URLs

  • RTD project pages for Getfem:

English Documentation Status

日本語 Documentation Status

Português 🇧🇷 Documentation Status

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 es ja
    - tx pull -l es,ja
    + rm -R es ja pt_BR
    + tx pull -l es,ja,pt_BR
    
  2. update po files

  3. commit them

  4. add new project on Read The Docs like:

    https://readthedocs.org/projects/getfem-pt-br/

  5. add translation project to parent project like:

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

About

project to provide Getfem official documentation with multiple versions and multiple languages on Read The Docs

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Sponsor this project

 

Packages

No packages published