Skip to content

Commit 423e77d

Browse files
authored
bpo-40204: Allow pre-Sphinx 3 syntax in the doc (GH-21844)
Enable Sphinx 3.2 "c_allow_pre_v3" option and disable the c_warn_on_allowed_pre_v3 option to make the documentation compatible with Sphinx 2 and Sphinx 3.
1 parent 6e0b788 commit 423e77d

File tree

2 files changed

+13
-0
lines changed

2 files changed

+13
-0
lines changed

Doc/conf.py

+10
Original file line numberDiff line numberDiff line change
@@ -228,3 +228,13 @@
228228

229229
# Relative filename of the reference count data file.
230230
refcount_file = 'data/refcounts.dat'
231+
232+
# Sphinx 2 and Sphinx 3 compatibility
233+
# -----------------------------------
234+
235+
# bpo-40204: Allow Sphinx 2 syntax in the C domain
236+
c_allow_pre_v3 = True
237+
238+
# bpo-40204: Disable warnings on Sphinx 2 syntax of the C domain since the
239+
# documentation is built with -W (warnings treated as errors).
240+
c_warn_on_allowed_pre_v3 = False
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
Enable Sphinx 3.2 ``c_allow_pre_v3`` option and disable
2+
``c_warn_on_allowed_pre_v3`` option to make the documentation compatible
3+
with Sphinx 2 and Sphinx 3.

0 commit comments

Comments
 (0)