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

doc: Add i18n support #159

Open
wants to merge 8 commits into
base: master
Choose a base branch
from
Open

doc: Add i18n support #159

wants to merge 8 commits into from

Conversation

lilvinz
Copy link

@lilvinz lilvinz commented Jan 26, 2025

  • Enable Sphinx i18n configuration with UUID-based message IDs
  • Add German (de) translation infrastructure
  • Update documentation with translation workflow in CONTRIBUTING.md
  • Configure .gitignore for translation artifacts

Consider this to be a proof of concept.

By now i am aware of pybricks/support#1345 but at least wanted to put this up for comments.

@lilvinz lilvinz changed the title doc: Add internationalization (i18n) support doc: Add i18n support Jan 26, 2025
@dlech
Copy link
Member

dlech commented Jan 26, 2025

Looks like a nice start. I'm not sure if we have the bandwidth to take on translations right at this moment, but when we do, I think, that starting with the docs would be a good place to start to help us establish how we want to manage translations in general, e.g. using an external service to help manage it or not. It's much easier to push out updated docs outside of the Pybricks Code app so that can really speed up the development/feedback cycle.

One thing I can see a need for here is to be able to add some annotations to give hints to translators on things like Restructured Text formatting that needs to be preserved and when words are Python identifiers that should not be translated.

Also, it looks like this is just pulling strings from the .rst files and not any of the doc comments from .py files. How hard will it be to add that?

@lilvinz
Copy link
Author

lilvinz commented Jan 30, 2025

I have added a possible solution regarding the code comments using a sphinx-plugin.

In regard to translators and workflow i think a lot can nowadays been achieved via LLMs. All the example translations i did so far was via Claude 3.5 and as a German native speaker i can say they are absolutely usable even without manual reworking.

Doing the rest in the same way is a matter of a few hours.

In general what i am looking for the most is a translation of the blocks - because thats what my kids are dealing with primarily.

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

Successfully merging this pull request may close these issues.

2 participants