You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Sphinx will try to translate strings on its own if it thinks it has sufficient information to do so.
Currently this can break some things in translated docs.
As an example, Sphinx knows how to translate Interact with Your Environment to German. Now it sees
:doc:`Interact with Your Environment <../../explore/interact>`
and thinks "That is close enough to Interact with Your Environment. I will just put the translation in automatically since we have no better translation." and replaces the whole string instead of strictly just the Interact with Your Environment with a translation, essentially removing the link and just putting plain text there.
Here is how the result of that looks:
EDIT: Originally I thought Weblate did this, but after a little more investigation, it turns out that Sphinx or a component of it does this. The issue happens on the newest stable version of Sphinx (3.5.3) as well.
The text was updated successfully, but these errors were encountered:
JulianGro
changed the title
Weblate breaks things by trying to translate them automatically
Sphinx breaks things by trying to translate them automatically
Mar 29, 2021
Apparently this is a bug in recommonmark: readthedocs/recommonmark#163
There is a PR with a fix open, but apparently recommonmark is badly supported and is likely going to be deprecated in favor of MyST-Parser.
MyST-Parser is might work as a drop-in replacement which I will have to test at some point.
Sphinx will try to translate strings on its own if it thinks it has sufficient information to do so.
Currently this can break some things in translated docs.
As an example, Sphinx knows how to translate
Interact with Your Environment
to German. Now it seesand thinks "That is close enough to
Interact with Your Environment
. I will just put the translation in automatically since we have no better translation." and replaces the whole string instead of strictly just theInteract with Your Environment
with a translation, essentially removing the link and just putting plain text there.Here is how the result of that looks:
EDIT: Originally I thought Weblate did this, but after a little more investigation, it turns out that Sphinx or a component of it does this. The issue happens on the newest stable version of Sphinx (3.5.3) as well.
The text was updated successfully, but these errors were encountered: