From 848aa1e89ed0e6bd45f5c25f6798f02ad4138db9 Mon Sep 17 00:00:00 2001 From: Ruth Comer <10599679+rcomer@users.noreply.github.com> Date: Mon, 24 Apr 2023 20:51:03 +0100 Subject: [PATCH] Backport PR #25760: unbreak doc build with Sphinx 6.2 --- doc/sphinxext/missing_references.py | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/doc/sphinxext/missing_references.py b/doc/sphinxext/missing_references.py index 12d836f296f1..772d222c2161 100644 --- a/doc/sphinxext/missing_references.py +++ b/doc/sphinxext/missing_references.py @@ -278,6 +278,10 @@ def prepare_missing_references_handler(app): # for use later. Otherwise, add all known missing references to # ``nitpick_ignore``` if not app.config.missing_references_write_json: + # Since Sphinx v6.2, nitpick_ignore may be a list, set or tuple, and + # defaults to set. Previously it was always a list. Cast to list for + # consistency across versions. + app.config.nitpick_ignore = list(app.config.nitpick_ignore) app.config.nitpick_ignore.extend(ignored_references.keys())