Skip to content

gh-93738: Disallow pre-v3 syntax in the C domain #97962

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ambv merged 4 commits into from
Oct 6, 2022
Merged

gh-93738: Disallow pre-v3 syntax in the C domain #97962

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
29e8054
Disallow pre-v3 syntax in the C domain
AA-Turner Jun 11, 2022
c0e92b5
Don't use sphinx-lint 0.6.2
AA-Turner Oct 6, 2022
dfc0949
Add rationale
AA-Turner Oct 6, 2022
7ad39af
Clean up leftover pre-v3 syntax
AA-Turner Oct 6, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
Disallow pre-v3 syntax in the C domain
  • Loading branch information
@AA-Turner
AA-Turner committed Oct 6, 2022
commit 29e805494449a6fae1bed973fc3b3f884950180d
25 changes: 0 additions & 25 deletions Doc/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -239,28 +239,3 @@
# Relative filename of the data files
refcount_file = 'data/refcounts.dat'
stable_abi_file = 'data/stable_abi.dat'

# Sphinx 2 and Sphinx 3 compatibility
# -----------------------------------

# bpo-40204: Allow Sphinx 2 syntax in the C domain
c_allow_pre_v3 = True

# 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