Internationalization of PyAnsys sphinx document

[tkoyama010]

PyVista has a documentation internationalization project and has created a page in Japanese.

About translating of PyVista: https://docs.pyvista.org/version/stable/#translating
Japanese page: https://pyvista.github.io/pyvista-docs-dev-ja/index.html

This is based on the internationalization feature of Sphinx.

• https://www.sphinx-doc.org/en/master/usage/advanced/intl.html

The documentation of Sphinx itself is also internationalized in this way.

• English page: https://www.sphinx-doc.org/en/master/
• Spanish page: https://www.sphinx-doc.org/es/master/
• Japanese page: https://www.sphinx-doc.org/ja/master/

Could we use PyAnsys documentation to follow suit and internationalize? If people can understand the documentation in their language when they read it, it will be more accessible to them.

I do not have an Ansys license myself so I cannot build the documentation, but I can comment on how it can be internationalized.

[RobPasMue]

This might be a good idea we can explore @ansys/pyansys-core - we should definitely give it a try.

[tkoyama010]

Yes! I opened the Japanese pymapdl page now 🎉 🎉 🎉

Below is the Repository that hosts the Repository and GitHub Pages that summarize the data and procedures for the translation. Once these operations are stable, we would like to ask the Ansys organization to manage them.

1. Project to provide pymapdl official documentation in multiple languages
2. Repository to hosting Japanese pymapdl documentation GitHub page

Caution

Note that the Japanese page is still being translated. The untranslated sections are in English. Therefore, we are looking for translator members to help with the translation according to the "Contributing to pymapdl documentation translation" section of the 1 repository. We will soon have a Spanish page as well, so please actively participate in translating this page as well.

Of course, you can also apply for other languages. Please check the repository description for more information.

[tkoyama010]

It says there are 370K words to translate.

[RobPasMue]

Hi @tkoyama010 thanks for demonstrating how this can be done! It's definitely a learning experience for all of us. We will have to see whether we can take over such an effort on our side or not, as it appears that the final translation has to be done "by hand". It my imply a lot of work on our already overloaded dev team. But we will definitely discuss it! :)

[tkoyama010]

@RobPasMue
Thank you for your favorable comments. I understand that the development team is very busy. Rest assured, I plan to maintain the system by myself for at least one to two years to see how the community responds.

1. For now, I will send a Pull Request to pymapdl to add to the documentation explaining how to contribute to the translation.
2. It may not be possible right away, but it would be great if we could add a language-switching option to the version number-switching section. I am thinking of posting this as an issue.

[tkoyama010]

I started thinking it would be a good idea to merge my po files into pymapdl using the same procedure as pyOpenSci's python-package-guide/TRANSLATING.md. I am happy to create a Pull Request about it.