[all][sphinx] "rST localisation for language "foo" not found" error
We've seen issues in some projects, whereby attempting to build translations as part of the 'openstack-tox-docs' zuul job [1] can result in the following warning:
Warning, treated as error: ../doc/source/contributor/contributing.rst::rST localisation for language "id" not found.
Based on [2], this issue appears to have been introduced by a recent version bump of docutils, which was in turn introduced by the introduction of Sphinx 4.x.
We don't have a resolution for this bug yet but we'll update when we do. Hopefully this email will improve the "Google'ability" of this bug.
Stephen
[1] https://opendev.org/openstack/openstackdocstheme/src/commit/08461c5311aa6920... [2] https://lists.freebsd.org/pipermail/freebsd-ports/2021-April/120848.html
On Wed, 2021-07-28 at 17:11 +0100, Stephen Finucane wrote:
We've seen issues in some projects, whereby attempting to build translations as part of the 'openstack-tox-docs' zuul job [1] can result in the following warning:
Warning, treated as error: ../doc/source/contributor/contributing.rst::rST localisation for language "id" not found.
Based on [2], this issue appears to have been introduced by a recent version bump of docutils, which was in turn introduced by the introduction of Sphinx 4.x.
We don't have a resolution for this bug yet but we'll update when we do. Hopefully this email will improve the "Google'ability" of this bug.
I _think_ this is because we're only allowed to use languages that docutils officially supports now, which presumably are those listed here [1]. We spotted this bug initially for openstack-helm, which has translations for Indonesian with a shortcode of 'id'. That's not in the list supported by docutils, hence this issue. Will need more investigation from people familiar with this tooling though.
Stephen
[1] https://repo.or.cz/docutils.git/tree/HEAD:/docutils/docutils/languages
Stephen
[1] https://opendev.org/openstack/openstackdocstheme/src/commit/08461c5311aa6920... [2] https://lists.freebsd.org/pipermail/freebsd-ports/2021-April/120848.html
---- On Wed, 28 Jul 2021 11:20:06 -0500 Stephen Finucane stephenfin@redhat.com wrote ----
On Wed, 2021-07-28 at 17:11 +0100, Stephen Finucane wrote:
We've seen issues in some projects, whereby attempting to build translations as part of the 'openstack-tox-docs' zuul job [1] can result in the following warning:
Warning, treated as error: ../doc/source/contributor/contributing.rst::rST localisation for language "id" not found.
Based on [2], this issue appears to have been introduced by a recent version bump of docutils, which was in turn introduced by the introduction of Sphinx 4.x.
We don't have a resolution for this bug yet but we'll update when we do. Hopefully this email will improve the "Google'ability" of this bug.
I _think_ this is because we're only allowed to use languages that docutils officially supports now, which presumably are those listed here [1]. We spotted this bug initially for openstack-helm, which has translations for Indonesian with a shortcode of 'id'. That's not in the list supported by docutils, hence this issue. Will need more investigation from people familiar with this tooling though.
It is happening in openstack/contributor-guide also, not sure if any resolution to this yet?
-https://zuul.opendev.org/t/openstack/build/c01d12032a0449a28988e6daa45a7d87/...
-gmann
Stephen
[1] https://repo.or.cz/docutils.git/tree/HEAD:/docutils/docutils/languages
Stephen
[1] https://opendev.org/openstack/openstackdocstheme/src/commit/08461c5311aa6920... [2] https://lists.freebsd.org/pipermail/freebsd-ports/2021-April/120848.html
participants (2)
-
Ghanshyam Mann
-
Stephen Finucane