Availability extension's text translation breaks directive rendering

[rffontenelle]

Documentation

The availability extension shows "Availability" text in the built docs. In the translation context, "Availability" is available for translation, but translating that text causes hundreds of warnings like this:

Warning: /path/to/cpython/Doc/library/os.rst:181: WARNING: inconsistent term references in translated message. original: ['Availability'], translated: [] [i18n.inconsistent_references]

The translated page will show the translation text ("Disponibilidade", in Portuguese) without the important text: the platforms where it is available. (That's unwanted!)

Some checking around:

• In original English, os.ctermid() shows "Availability: Unix, not WASI.". See source file Doc/library/os.rst
• In Brazilian Portuguese, os.ctermid() shows "Disponibilidade" but without the plataforms and without the hyperlink. See the string in the translation file (library/os.po)
• in Simplified Chinese, I see in os.ctermid() they translated keeping "Availability" in English to escape this issue 😁. See the string in the translation file (library/os.po)

Linked PRs

• gh-126609: Revert commit cbfd3924 to fix errors #129479
• gh-126609: Revert Availability Directive changes #129480
• gh-126609: docs: revert changes made to the internal structure of availability directive #129482
• gh-126609: Allow translating the availability directive #129549
• [3.13] gh-126609: Allow translating the availability directive (GH-129549) #129584
• [3.12] gh-126609: Allow translating the availability directive (GH-129549) #129585
• gh-126609: localize list, allow translation of a phrase, use ge operator character in the availability directive #129597

[AA-Turner]

There's been a few other issues about this extension -- is this related to those at all?

A

[rffontenelle]

After reviewing issues and PRs open and closed, it doesn't look like they are related.

For the record, this issues started after extracting availability into a new extension. I git-checkout'ed it and built the docs to test it.

[m-aciek]

PL translation got impacted yesterday by this issue. Confirming that translating "Availability" (exposed to translation by the directive) to "Dostępność" (Polish translation) breaks rendering of the directive (as shown on screenshots).

• build of Polish docs with the issue
• logs with warnings from the HTML build process

@rffontenelle I suggest renaming the ticket to „Availability extension's text translation breaks directive rendering” or similar.

Broken rendering:

Non-intl rendering:

[StanFromIreland]

I have opened a PR that reverts the move.

[m-aciek]

For what it's worth translation Dostępność <availability> doesn't generate a correct reference.

[AA-Turner]

It seems that I missed the sphinx_gettext call here to allow translation. I've attempted to test #129549 locally and it seems to work, but please could someone here test it with an actual translation?

A