languages/cpython
languages/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython synced 2024-10-14 19:21:29 +00:00
Code Issues Packages Projects Releases Wiki Activity

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

Browse source 
* gh-97740: Fix bang in Sphinx C domain ref target syntax

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>

* Add NEWS entry for C domain bang fix

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
This commit is contained in:
C.A.M. Gerlach 2022-10-02 22:51:22 -05:00 committed by GitHub
parent 19ca114645
commit 9148c0d893
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 17 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
Doc/conf.py
View file

@ -249,3 +249,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

2
Misc/NEWS.d/next/Documentation/2022-10-02-10-58-52.gh-issue-97741.39l023.rst Normal file
View file

@ -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.