-
-
Notifications
You must be signed in to change notification settings - Fork 3.6k
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
what is the most efficient way to support translation ? #9903
Comments
@12rambau, as mentioned in https://docs.readthedocs.io/en/stable/localization.html#project-with-multiple-translations you need to create one RTD project per translation and add them as translations of your main project.
When importing a project, in the advanced settings you can choose the language of that project, that would be used when running sphinx on rtd, i.e
Yes, but you need to import them manually, this is from https://readthedocs.org/dashboard/import/manual/. I think the integration (webhooks to trigger a new build on each commit) should be created automatically, but if not, you can follow this guide https://docs.readthedocs.io/en/stable/integrations.html.
locale_dirs should be enough. |
I managed to make it work, Thanks for your help. I'll propose an edit of the doc accordingly. |
That would be great, thank you! |
sorry for not updating anything, I didn't find the time |
@humitos I don't think this has been resolved yet, we still need to update our documentation |
What are parts of the documentation we have to update? What's the content we need to add/change/delete? |
now that I know this seems clear: https://docs.readthedocs.io/en/stable/localization.html#project-with-multiple-translations but it wasn't when I arrived so I think it can be refreshed so that new devs like me stop opening issues related to translating a project under the same url |
@12rambau would you like to update that page to reflect your findings? |
thanks for reposting it it was a the depth of my notification dashboard. I'll try to gather everything this WE |
context
This is not a bug per se, I think it's more a documentation request, as I have all the difficulties in the world understanding how to support parralel build of the same documentation in multiple languages. What I would like to do here is write down what I understood, wait for your answers, and when it will work propose some updates to the RDT documentation.
Note that I come here after reading:
The behavior I would like to reproduce is the one from the Sphinx documentation itself.
step 1 prepare the repository
For the sake of example I created a pet project here: https://github.com/12rambau/docs. The documentation is hosted here: https://docs-test-pierrick.readthedocs.io/en/latest/.
First I prepared the appropiate files using
sphinx
andsphinx-intl
:To generate the .pot files
To create the .po files in
/locale
.In these translation files, I added the translations in french and tested the documentation by changing the
language
parameter in myconf.py
file. At the moment everything is sent to my distant repo but some cleaning will be necessary once I better understand what is regenerated on the fly.step 2: deploy on RDT
Now is the real deal, how to activate these different versions in RDT. I would like to make it as automatic as possible so that when I updated stuff on transifex/crowdin I don't have 7 RDT projects to update and check.
What I think I should do is:
My question are then:
locale_dirs
in myconf.py
?The text was updated successfully, but these errors were encountered: