brightway-lca / brightway-documentation

📚🌿 readthedocs.org Sphinx Documentation for Brightway
https://docs.brightway.dev
BSD 3-Clause "New" or "Revised" License
4 stars 38 forks source link

Implement Translation/Multi-Language Functionality #119

Closed michaelweinold closed 2 months ago

michaelweinold commented 1 year ago

At the request of Brightway resident linguist @tngTUDOR work is to commence to add multi-language functionality to the Brightway documentation.

As luck would have it, I recently came across this PR in the pydata-sphinx-theme repo related to a project that uses translations heavily:

As you support heavy translation I would be happy to promote it to featured afterward, please open an issue if I forget.

Perhaps we could take some inspiration from their setup.

michaelweinold commented 1 year ago

If I might be so bold, @tngTUDOR : What is the real case for this? My main concerns:

tngTUDOR commented 1 year ago

yes, I was thinking specifically about the "explanations" pages themselves. @michaelweinold can you point me to what you mean by "browser translation" ?

michaelweinold commented 1 year ago

can you point me to what you mean by "browser translation"?

Chrome (native) Safari (native) Firefox (plugin)

michaelweinold commented 1 year ago

...maybe as additional food for thought:

How would we ensure that contributions such as eg. https://github.com/brightway-lca/brightway-documentation/pull/118 are propagated to the other-than-English branches?

Would we auto-translate those (in which case, 👀 browser translation) or would we need to set up a strategy that assigns language experts (from the Brightway developers?) to these PRs?

michaelweinold commented 2 months ago

Closing this for now - localisation of the entire (or part of) documentation would be a major effort that should only be undertaken after the English-language content of the documentation has been expanded/consolidated.