gh-97740: Fix bang in Sphinx C domain ref target syntax (GH-97741)

* gh-97740: Fix bang in Sphinx C domain ref target syntax Co-authored-by: Adam Turner <[email protected]> * Add NEWS entry for C domain bang fix Co-authored-by: Adam Turner <[email protected]> (cherry picked from commit 9148c0d) Co-authored-by: C.A.M. Gerlach <[email protected]>
python · Oct 3, 2022 · a1711ef · a1711ef
1 parent c2d3f73
commit a1711ef
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 0 deletions.
diff --git a/Doc/conf.py b/Doc/conf.py
@@ -244,3 +244,18 @@
 # bpo-40204: Disable warnings on Sphinx 2 syntax of the C domain since the
 # documentation is built with -W (warnings treated as errors).
 c_warn_on_allowed_pre_v3 = False
+
+# Fix '!' not working with C domain when pre_v3 is enabled
+import sphinx
+
+if sphinx.version_info[:2] < (5, 3):
+    from sphinx.domains.c import CXRefRole
+
+    original_run = CXRefRole.run
+
+    def new_run(self):
+        if self.disabled:
+            return super(CXRefRole, self).run()
+        return original_run(self)
+
+    CXRefRole.run = new_run
diff --git a/Misc/NEWS.d/next/Documentation/2022-10-02-10-58-52.gh-issue-97741.39l023.rst b/Misc/NEWS.d/next/Documentation/2022-10-02-10-58-52.gh-issue-97741.39l023.rst
@@ -0,0 +1,2 @@
+Fix ``!`` in c domain ref target syntax via a ``conf.py`` patch, so it works
+as intended to disable ref target resolution.