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

documentation: make the diagram on the "Quality gateway" section translatable #5201

Open
Fat-Zer opened this issue Jan 13, 2021 · 3 comments
Labels
documentation Improvements or additions to the documentation. enhancement Adding or requesting a new feature.

Comments

@Fat-Zer
Copy link
Collaborator

Fat-Zer commented Jan 13, 2021

Describe the issue

There is a diagram on the Quality gateway section of the translation workflows chapter. It would be nice to translate labels on that one.

Expected behavior

I wish it would be translatable by either of methods:

  • Extracting the labels and translating them separately
  • Extracting the diagram code as a whole and translating it as a single unit
@nijel nijel added the enhancement Adding or requesting a new feature. label Jan 13, 2021
@nijel
Copy link
Member

nijel commented Jan 13, 2021

Most likely this has to be addressed at https://www.sphinx-doc.org/, we're just using existing internationalization support there. It uses graphviz to render the diagrams.

@nijel nijel added the documentation Improvements or additions to the documentation. label Jan 13, 2021
@Fat-Zer
Copy link
Collaborator Author

Fat-Zer commented Jan 13, 2021

@nijel, I suspect it's likely a matter of the Sphinx's configuration rather than itself. The gettext_additional_targets option looks promising, but I'm not familiar enough neither with the Sphinx nor with how Weblate actually uses it to tell you how to do it exactly and what will be the consequences...

If you could give me some hints how to build the PO files for the documentation from the command line, I may later experiment with that a bit to came up with a more concrete solution.

PS: as a side effect this will likely cause extraction of code snippets and config examples, which allow to translate comments inside those.

@nijel
Copy link
Member

nijel commented Jan 13, 2021

It doesn't seem to work this way.

Once you install Sphinx and other needed tools (pip install -r docs/requirements.txt), you can build the POT file using make locales/docs.pot.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to the documentation. enhancement Adding or requesting a new feature.
Projects
None yet
Development

No branches or pull requests

2 participants