authoress / sphinx-intl-guide Goto Github PK

Once our awesome project is cautiously documented, carefully translated and beautifully built, only thing left is for us to publish it.
This is a final step that's missing from the guide today that would close the circle.

Possible options that could be documented :

• Push/sync to any bare Web hosting
• GitHub pages
• And the all mighty ReadTheDocs.org !
  This last one of course already having docs (https://docs.readthedocs.io/en/latest/localization.html and https://docs.readthedocs.io/en/latest/guides/manage-translations-sphinx.html) may just be cross-referenced (who said intersphinx i18n ?)
  Note that they're already discussing to reference this guide into their docs in readthedocs/readthedocs.org#9000... Hope they'll join the tchat :)

Any other valuable option ?

It would be nice that Transifex integration and setup be included in the guide.

Maybe another section presenting the workflow with an Open Source Desktop CAT tool would ice the cake as well as be a practical example of language dependent images with screenshots ?

Hi,

During the searches that led me to discover this nice guide, I found that there were at least two other translation repository strategies used by sphinx-doc projects, aside of the 'mono-branch' one described ATM:

• Dual branch: translations are maintained in a separate, translation dedicated, branch.
  I have to make a second pass to grasp the pros of this one and see if some use language specific branches.
• Dual repo: translations are maintained in a separate repo.
  Major pro of this strategy is avoiding cluttering the main repo history with translations commits.
  Again, I have to dig deeper to get all the pros and cons.

If you don't mind, I'll announce publishing of this guide source and RFC to this in the few most significant issues where I've found the guide mentioned :)

Thanks again for sharing this
TY
J

It would be nice to have the translations managed with Transifex as support is built-in sphinx-intl (hope other TMSs like Weblate will be added in the future...), furthermore if that is added to the guide (see #3 ).

@authoress how would you like it to be done at the organizational level ?
Do you already have an organization @transifex ?
Would you mind creating one for your contents for us to contribute to ?
Would you need/want help to manage the projects in that organization ?