From 0c14b6085a117af4a1cafa0b1b14aa6ceb343781 Mon Sep 17 00:00:00 2001 From: Henry Schreiner Date: Tue, 20 Jun 2023 17:38:03 -0400 Subject: Utilities/Sphinx: Fix warning from docutils 0.18.1+ Also might fix 0.18.0 exactly, which apparently forgot to add the backward compat shim. --- Utilities/Sphinx/cmake.py | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/Utilities/Sphinx/cmake.py b/Utilities/Sphinx/cmake.py index 0afd705..da2609a 100644 --- a/Utilities/Sphinx/cmake.py +++ b/Utilities/Sphinx/cmake.py @@ -582,12 +582,23 @@ class CMakeXRefTransform(Transform): # after the sphinx (210) and docutils (220) substitutions. default_priority = 221 + # This helper supports docutils < 0.18, which is missing 'findall', + # and docutils == 0.18.0, which is missing 'traverse'. + def _document_findall_as_list(self, condition): + if hasattr(self.document, 'findall'): + # Fully iterate into a list so the caller can grow 'self.document' + # while iterating. + return list(self.document.findall(condition)) + + # Fallback to 'traverse' on old docutils, which returns a list. + return self.document.traverse(condition) + def apply(self): env = self.document.settings.env # Find CMake cross-reference nodes and add index and target # nodes for them. - for ref in self.document.traverse(addnodes.pending_xref): + for ref in self._document_findall_as_list(addnodes.pending_xref): if not ref['refdomain'] == 'cmake': continue -- cgit v0.12