i18n strategies about symbol-docs

[dgarcia360]

Instead of using .rst files for generating landings, Sphinx accepts as well jinja html pages. Will migrate home and references pages to enable translation 👍

https://ofosos.org/2018/12/28/landing-page-template/

[dgarcia360]

Just applied the change proposed to the cow branch. index and reference pages should be translatable after the next release.

[dgarcia360]

Relevant conversation: sphinx-doc/sphinx#1235

[kaiyzen]

not super experienced with translation templating and handling on sphinx so will read up more, but maybe an approach where make/build of the docs can be enhanced or extended so for html type pages we can maintain en, ja, etc versions of each to be included based on language target

[dgarcia360]

@kaiyzen translation is already enabled taking English as the base language.

• Example: https://nemtech.github.io/ja/getting-started/what-is-nem.html
• Guide: https://nemtech.github.io/support/translating-the-documentation.html

The problem right now is that some UI elements are not automatically recognized by the Sphinx translation system.

[44uk]

By adding gettext_additional_targets = ['raw'] option to source/conf.py, it creates PO file including raw directive.
It can be translatable, but little hard to edit because they are containing html tags.

[kaiyzen]

@dgarcia360 my point was more about duping those assets that sphinx doesn't support native string translation, so instead of saying "build jp version of the docs" and relying on its native string i18n sub functionality, would be more "build the jp version of the jp docs", where repo would have jp, en, etc versions of the pieces that cant be natively translated/substituted by sphinx

not sure how possible or hacky it would be or if simple tweak/hack of an existing extension

[dgarcia360]

Added gettext tags to the footer, so now it should be translatable:

e5023b5#diff-67dcea514bdf82dd986b048ef2e4f679

@44uk Seems the best solution right now, altough is not convenient. Will investigate a little bit further before enabling gettext_additional_targets = ['raw'].

[dgarcia360]

Interesting article by @44uk to integrate transifex with Sphinx to reduce the difficulty of translating .po files directly:

https://blog.44uk.net/2018/11/03/how-to-use-transifex/

[dgarcia360]

@44uk Started integrating transifex with sphinx. The command make gettext seems not to work due to an issue with ablog.

Pushed as well a PR fixing the bug, let's wait until sunpy launches the release to continue with transifex integration.