From 7b8b3de9d1c8ee042929d0b3b5d873e58ca29415 Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Sun, 13 Jun 2021 22:22:15 +0900 Subject: [PATCH] Fix #9330: versionchanged causes error during pdf build The versionchanged directive breaks doctree if its contents start with non-paragraph element (ex. lists, tables, and so on). It causes build error in LaTeX. This inserts a paragraph if the first child of the contents is not a paragraph not to break doctree. --- CHANGES | 2 ++ sphinx/domains/changeset.py | 16 ++++++++++++---- 2 files changed, 14 insertions(+), 4 deletions(-) diff --git a/CHANGES b/CHANGES index 6710a63a5a3..9d773318793 100644 --- a/CHANGES +++ b/CHANGES @@ -16,6 +16,8 @@ Features added Bugs fixed ---------- +* #9330: changeset domain: :rst:dir:`versionchanged` with contents being a list + will cause error during pdf build * #9313: LaTeX: complex table with merged cells broken since 4.0 Testing diff --git a/sphinx/domains/changeset.py b/sphinx/domains/changeset.py index 1b31e0248a2..81c81c2882c 100644 --- a/sphinx/domains/changeset.py +++ b/sphinx/domains/changeset.py @@ -74,8 +74,10 @@ def run(self) -> List[Node]: if self.content: self.state.nested_parse(self.content, self.content_offset, node) classes = ['versionmodified', versionlabel_classes[self.name]] - if len(node): - if isinstance(node[0], nodes.paragraph) and node[0].rawsource: + if len(node) > 0 and isinstance(node[0], nodes.paragraph): + # the contents start with a paragraph + if node[0].rawsource: + # make the first paragraph translatable content = nodes.inline(node[0].rawsource, translatable=True) content.source = node[0].source content.line = node[0].line @@ -84,10 +86,16 @@ def run(self) -> List[Node]: para = cast(nodes.paragraph, node[0]) para.insert(0, nodes.inline('', '%s: ' % text, classes=classes)) + elif len(node) > 0: + # the contents do not starts with a paragraph + para = nodes.paragraph('', '', + nodes.inline('', '%s: ' % text, classes=classes), + translatable=False) + node.insert(0, para) else: + # the contents are empty para = nodes.paragraph('', '', - nodes.inline('', '%s.' % text, - classes=classes), + nodes.inline('', '%s.' % text, classes=classes), translatable=False) node.append(para)