Availability extension's text translation breaks directive rendering

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

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

A

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.

@rffontenelle

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).

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

Broken rendering:

Non-intl rendering:

I have opened a PR that reverts the move.

pythongh-126609: docs: revert changes made to the internal structure …

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

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

gh-126609: Allow translating the ``availability`` directive (#129549)

pythongh-126609: Allow translating the ``availability`` directive (py…

[3.12] gh-126609: Allow translating the ``availability`` directive (G…

[3.13] gh-126609: Allow translating the ``availability`` directive (G…

pythongh-126609: Allow translating the ``availability`` directive (py…

Navigation Menu

Repository navigation

Availability extension's text translation breaks directive rendering #126609

Documentation

Linked PRs

Metadata

Assignees

Labels

Projects

Milestone

Relationships

Development

Availability extension's text translation breaks directive rendering #126609

Description

Documentation

Linked PRs

Activity

AA-Turner commented on Nov 9, 2024

rffontenelle commented on Nov 9, 2024

m-aciek commented on Jan 30, 2025

StanFromIreland commented on Jan 30, 2025

m-aciek commented on Feb 1, 2025

AA-Turner commented on Feb 1, 2025

Metadata

Metadata

Assignees

Labels

Projects

Milestone

Relationships

Development

Issue actions