From: Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Date: Wed, 26 Jul 2023 16:16:04 +0000 (-0700)
Subject: [3.12] gh-106948: Update documentation nitpick_ignore for c:identifer domain (GH... 
X-Git-Tag: v3.12.0rc1~64
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=0d2e1317bd4d13c1652a08c3ad8199c03387f73b;p=thirdparty%2FPython%2Fcpython.git

[3.12] gh-106948: Update documentation nitpick_ignore for c:identifer domain (GH-107295) (#107297)

gh-106948: Update documentation nitpick_ignore for c:identifer domain (GH-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.

(cherry picked from commit b1de3807b832b72dfeb66dd5646159d08d2cc74a)

Co-authored-by: Victor Stinner <vstinner@python.org>
Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
---

diff --git a/Doc/conf.py b/Doc/conf.py
index 067aa1d9e229..209656be4ad4 100644
--- a/Doc/conf.py
+++ b/Doc/conf.py
@@ -153,6 +153,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'],
diff --git a/Doc/tools/.nitignore b/Doc/tools/.nitignore
index b6adbcb34663..849ef1168b45 100644
--- a/Doc/tools/.nitignore
+++ b/Doc/tools/.nitignore
@@ -9,7 +9,6 @@ Doc/c-api/arg.rst
 Doc/c-api/bool.rst
 Doc/c-api/buffer.rst
 Doc/c-api/bytes.rst
-Doc/c-api/call.rst
 Doc/c-api/capsule.rst
 Doc/c-api/cell.rst
 Doc/c-api/code.rst
@@ -28,8 +27,6 @@ Doc/c-api/init.rst
 Doc/c-api/init_config.rst
 Doc/c-api/intro.rst
 Doc/c-api/iterator.rst
-Doc/c-api/long.rst
-Doc/c-api/marshal.rst
 Doc/c-api/memory.rst
 Doc/c-api/memoryview.rst
 Doc/c-api/module.rst