From 7d8ea9b4d6d8a2adb59def62fa07b23d45379712 Mon Sep 17 00:00:00 2001 From: Maciej Olko Date: Thu, 30 Jan 2025 19:36:37 +0100 Subject: [PATCH 1/3] gh-126609: docs: revert changes made to the internal structure of availability directive In #125082. --- Doc/tools/extensions/availability.py | 20 ++++++-------------- 1 file changed, 6 insertions(+), 14 deletions(-) diff --git a/Doc/tools/extensions/availability.py b/Doc/tools/extensions/availability.py index 47833fdcb87590..e4047dad2d4eb8 100644 --- a/Doc/tools/extensions/availability.py +++ b/Doc/tools/extensions/availability.py @@ -55,20 +55,12 @@ class Availability(SphinxDirective): final_argument_whitespace = True def run(self) -> list[nodes.container]: - title = "Availability" - refnode = addnodes.pending_xref( - title, - nodes.inline(title, title, classes=["xref", "std", "std-ref"]), - refdoc=self.env.docname, - refdomain="std", - refexplicit=True, - reftarget="availability", - reftype="ref", - refwarn=True, - ) - sep = nodes.Text(": ") - parsed, msgs = self.state.inline_text(self.arguments[0], self.lineno) - pnode = nodes.paragraph(title, "", refnode, sep, *parsed, *msgs) + availability_ref = ':ref:`Availability `: ' + avail_nodes, avail_msgs = self.state.inline_text( + availability_ref + self.arguments[0], + self.lineno) + pnode = nodes.paragraph(availability_ref + self.arguments[0], + '', *avail_nodes, *avail_msgs) self.set_source_info(pnode) cnode = nodes.container("", pnode, classes=["availability"]) self.set_source_info(cnode) From c692105afe53eb860ba942b639f7139c1ae202b4 Mon Sep 17 00:00:00 2001 From: Maciej Olko Date: Thu, 30 Jan 2025 19:42:12 +0100 Subject: [PATCH 2/3] Remove unused import. --- Doc/tools/extensions/availability.py | 1 - 1 file changed, 1 deletion(-) diff --git a/Doc/tools/extensions/availability.py b/Doc/tools/extensions/availability.py index e4047dad2d4eb8..2bca56f7ec1870 100644 --- a/Doc/tools/extensions/availability.py +++ b/Doc/tools/extensions/availability.py @@ -5,7 +5,6 @@ from typing import TYPE_CHECKING from docutils import nodes -from sphinx import addnodes from sphinx.util import logging from sphinx.util.docutils import SphinxDirective From ba46cc954da0f042ce3266d44345b038bd51723a Mon Sep 17 00:00:00 2001 From: Maciej Olko Date: Thu, 30 Jan 2025 19:47:03 +0100 Subject: [PATCH 3/3] Reformat with ruff --- Doc/tools/extensions/availability.py | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/Doc/tools/extensions/availability.py b/Doc/tools/extensions/availability.py index 2bca56f7ec1870..c978c8419f6ce9 100644 --- a/Doc/tools/extensions/availability.py +++ b/Doc/tools/extensions/availability.py @@ -56,10 +56,11 @@ class Availability(SphinxDirective): def run(self) -> list[nodes.container]: availability_ref = ':ref:`Availability `: ' avail_nodes, avail_msgs = self.state.inline_text( - availability_ref + self.arguments[0], - self.lineno) - pnode = nodes.paragraph(availability_ref + self.arguments[0], - '', *avail_nodes, *avail_msgs) + availability_ref + self.arguments[0], self.lineno + ) + pnode = nodes.paragraph( + availability_ref + self.arguments[0], '', *avail_nodes, *avail_msgs + ) self.set_source_info(pnode) cnode = nodes.container("", pnode, classes=["availability"]) self.set_source_info(cnode)