Skip to content

Commit 6ef6915

Browse files
authored
gh-101845: pyspecific: Fix i18n for availability directive (GH-101846)
pyspecific: Fix i18n for availability directive If the directive has content, the previous code would nest paragraph nodes from that content inside a general paragraph node, which confuses Sphinx and leads it to drop the content when translating. Instead, use a container node for the body. Also use set_source_info so that any warnings have location info.
1 parent dfc2e06 commit 6ef6915

File tree

1 file changed

+11
-9
lines changed

1 file changed

+11
-9
lines changed

Doc/tools/extensions/pyspecific.py

+11-9
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@
2828
from sphinx.environment import NoUri
2929
from sphinx.locale import _ as sphinx_gettext
3030
from sphinx.util import status_iterator, logging
31+
from sphinx.util.docutils import SphinxDirective
3132
from sphinx.util.nodes import split_explicit_title
3233
from sphinx.writers.text import TextWriter, TextTranslator
3334

@@ -119,7 +120,7 @@ def run(self):
119120

120121
# Support for documenting platform availability
121122

122-
class Availability(Directive):
123+
class Availability(SphinxDirective):
123124

124125
has_content = True
125126
required_arguments = 1
@@ -139,18 +140,19 @@ class Availability(Directive):
139140

140141
def run(self):
141142
availability_ref = ':ref:`Availability <availability>`: '
143+
avail_nodes, avail_msgs = self.state.inline_text(
144+
availability_ref + self.arguments[0],
145+
self.lineno)
142146
pnode = nodes.paragraph(availability_ref + self.arguments[0],
143-
classes=["availability"],)
144-
n, m = self.state.inline_text(availability_ref, self.lineno)
145-
pnode.extend(n + m)
146-
n, m = self.state.inline_text(self.arguments[0], self.lineno)
147-
pnode.extend(n + m)
147+
'', *avail_nodes, *avail_msgs)
148+
self.set_source_info(pnode)
149+
cnode = nodes.container("", pnode, classes=["availability"])
150+
self.set_source_info(cnode)
148151
if self.content:
149-
self.state.nested_parse(self.content, self.content_offset, pnode)
150-
152+
self.state.nested_parse(self.content, self.content_offset, cnode)
151153
self.parse_platforms()
152154

153-
return [pnode]
155+
return [cnode]
154156

155157
def parse_platforms(self):
156158
"""Parse platform information from arguments

0 commit comments

Comments
 (0)