[Python-checkins] gh-97607: Fix content parsing in the impl-detail reST directive (#97652)
ezio-melotti
webhook-mailer at python.org
Sun Oct 2 01:20:31 EDT 2022
https://github.com/python/cpython/commit/e8165d47b852e933c176209ddc0b5836a9b0d5f4
commit: e8165d47b852e933c176209ddc0b5836a9b0d5f4
branch: main
author: C.A.M. Gerlach <CAM.Gerlach at Gerlach.CAM>
committer: ezio-melotti <ezio.melotti at gmail.com>
date: 2022-10-02T07:20:17+02:00
summary:
gh-97607: Fix content parsing in the impl-detail reST directive (#97652)
* Don't parse content as arg in the impl-detail directive
This does not change the (untranslated) output,
but ensures that the doctree node metadata is correct.
which fixes gh-97607 with the text not being translated.
It also simplifies the code and logic
and makes it consistant with the docutils built-in directives.
* Remove unused branch from impl-detail directive handling no-content case
This is not used anywhere in the docs and lacks a clear use case,
and is more likely a mistake which is now flagged at build time.
This simplifies the logic from two code paths to one,
and makes the behavior consistant with similar built-in directives
(e.g. the various admonition types).
* Further simplify impl-detail reST directive code
files:
M Doc/tools/extensions/pyspecific.py
diff --git a/Doc/tools/extensions/pyspecific.py b/Doc/tools/extensions/pyspecific.py
index da15abdf6372..8c3aa47ad1c7 100644
--- a/Doc/tools/extensions/pyspecific.py
+++ b/Doc/tools/extensions/pyspecific.py
@@ -100,33 +100,24 @@ def source_role(typ, rawtext, text, lineno, inliner, options={}, content=[]):
class ImplementationDetail(Directive):
has_content = True
- required_arguments = 0
- optional_arguments = 1
final_argument_whitespace = True
# This text is copied to templates/dummy.html
label_text = 'CPython implementation detail:'
def run(self):
+ self.assert_has_content()
pnode = nodes.compound(classes=['impl-detail'])
label = translators['sphinx'].gettext(self.label_text)
content = self.content
add_text = nodes.strong(label, label)
- if self.arguments:
- n, m = self.state.inline_text(self.arguments[0], self.lineno)
- pnode.append(nodes.paragraph('', '', *(n + m)))
self.state.nested_parse(content, self.content_offset, pnode)
- if pnode.children and isinstance(pnode[0], nodes.paragraph):
- content = nodes.inline(pnode[0].rawsource, translatable=True)
- content.source = pnode[0].source
- content.line = pnode[0].line
- content += pnode[0].children
- pnode[0].replace_self(nodes.paragraph('', '', content,
- translatable=False))
- pnode[0].insert(0, add_text)
- pnode[0].insert(1, nodes.Text(' '))
- else:
- pnode.insert(0, nodes.paragraph('', '', add_text))
+ content = nodes.inline(pnode[0].rawsource, translatable=True)
+ content.source = pnode[0].source
+ content.line = pnode[0].line
+ content += pnode[0].children
+ pnode[0].replace_self(nodes.paragraph(
+ '', '', add_text, nodes.Text(' '), content, translatable=False))
return [pnode]
More information about the Python-checkins
mailing list