[3.11] gh-106948: Update documentation nitpick_ignore for c:identifer domain (#107295...

gh-106948: Update documentation nitpick_ignore for c:identifer domain (#107295)

Update the nitpick_ignore of the documentation configuration to fix
Sphinx warnings about standard C types when declaring functions with
the "c:function" markups.

Copy standard C types declared in the "c:type" domain to the
"c:identifier" domain, since "c:function" markup looks for types in
the "c:identifier" domain.

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
(cherry picked from commit b1de3807b832b72dfeb66dd5646159d08d2cc74a)

diff --git a/Doc/conf.py b/Doc/conf.py
index 28c35f2b0a234853072e5d0d6010aae7ae5b5c0a..d5eea9cdfb88d1314764a630b412b09755592d12 100644 (file)
--- a/Doc/conf.py
+++ b/Doc/conf.py
@@ -148,6 +148,15 @@ nitpick_ignore = [
     ('py:meth', '_SubParsersAction.add_parser'),
 ]
 
+# gh-106948: Copy standard C types declared in the "c:type" domain to the
+# "c:identifier" domain, since "c:function" markup looks for types in the
+# "c:identifier" domain. Use list() to not iterate on items which are being
+# added
+for role, name in list(nitpick_ignore):
+    if role == 'c:type':
+        nitpick_ignore.append(('c:identifier', name))
+del role, name
+
 # Disable Docutils smartquotes for several translations
 smartquotes_excludes = {
     'languages': ['ja', 'fr', 'zh_TW', 'zh_CN'], 'builders': ['man', 'text'],