Visitar URL original
gh-86986: Drop compatibility support for Sphinx 2 (GH-93737) · python/cpython@cc42716 · GitHub
Skip to content

Commit cc42716

Browse files
miss-islingtonAA-Turner
miss-islington
and
AA-Turner
authored
gh-86986: Drop compatibility support for Sphinx 2 (GH-93737)
* Revert "bpo-42843: Keep Sphinx 1.8 and Sphinx 2 compatibility (GH-24282)" This reverts commit 5c1f15b * Revert "bpo-42579: Make workaround for various versions of Sphinx more robust (GH-23662)" This reverts commit b63a620. (cherry picked from commit 0efe3a1) Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
1 parent 1347607 commit cc42716

11 files changed

Lines changed: 18 additions & 52 deletions

File tree

‎Doc/conf.py‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -237,5 +237,3 @@
237237
# bpo-40204: Disable warnings on Sphinx 2 syntax of the C domain since the
238238
# documentation is built with -W (warnings treated as errors).
239239
c_warn_on_allowed_pre_v3 = False
240-
241-
strip_signature_backslash = True

‎Doc/library/asyncio-stream.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -192,7 +192,7 @@ StreamReader
192192
can be read. Use the :attr:`IncompleteReadError.partial`
193193
attribute to get the partially read data.
194194

195-
.. coroutinemethod:: readuntil(separator=b'\\n')
195+
.. coroutinemethod:: readuntil(separator=b'\n')
196196

197197
Read data from the stream until *separator* is found.
198198

‎Doc/library/base64.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -201,7 +201,7 @@ The modern interface provides:
201201
.. versionadded:: 3.4
202202

203203

204-
.. function:: a85decode(b, *, foldspaces=False, adobe=False, ignorechars=b' \\t\\n\\r\\v')
204+
.. function:: a85decode(b, *, foldspaces=False, adobe=False, ignorechars=b' \t\n\r\v')
205205

206206
Decode the Ascii85 encoded :term:`bytes-like object` or ASCII string *b* and
207207
return the decoded :class:`bytes`.

‎Doc/library/difflib.rst‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -149,7 +149,7 @@ diffs. For comparing directories and files, see also, the :mod:`filecmp` module.
149149
contains a good example of its use.
150150

151151

152-
.. function:: context_diff(a, b, fromfile='', tofile='', fromfiledate='', tofiledate='', n=3, lineterm='\\n')
152+
.. function:: context_diff(a, b, fromfile='', tofile='', fromfiledate='', tofiledate='', n=3, lineterm='\n')
153153

154154
Compare *a* and *b* (lists of strings); return a delta (a :term:`generator`
155155
generating the delta lines) in context diff format.
@@ -279,7 +279,7 @@ diffs. For comparing directories and files, see also, the :mod:`filecmp` module.
279279
emu
280280

281281

282-
.. function:: unified_diff(a, b, fromfile='', tofile='', fromfiledate='', tofiledate='', n=3, lineterm='\\n')
282+
.. function:: unified_diff(a, b, fromfile='', tofile='', fromfiledate='', tofiledate='', n=3, lineterm='\n')
283283

284284
Compare *a* and *b* (lists of strings); return a delta (a :term:`generator`
285285
generating the delta lines) in unified diff format.
@@ -321,7 +321,7 @@ diffs. For comparing directories and files, see also, the :mod:`filecmp` module.
321321

322322
See :ref:`difflib-interface` for a more detailed example.
323323

324-
.. function:: diff_bytes(dfunc, a, b, fromfile=b'', tofile=b'', fromfiledate=b'', tofiledate=b'', n=3, lineterm=b'\\n')
324+
.. function:: diff_bytes(dfunc, a, b, fromfile=b'', tofile=b'', fromfiledate=b'', tofiledate=b'', n=3, lineterm=b'\n')
325325

326326
Compare *a* and *b* (lists of bytes objects) using *dfunc*; yield a
327327
sequence of delta lines (also bytes) in the format returned by *dfunc*.

‎Doc/library/email.header.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ Here is the :class:`Header` class description:
116116
if *s* is a byte string.
117117

118118

119-
.. method:: encode(splitchars=';, \\t', maxlinelen=None, linesep='\\n')
119+
.. method:: encode(splitchars=';, \t', maxlinelen=None, linesep='\n')
120120

121121
Encode a message header into an RFC-compliant format, possibly wrapping
122122
long lines and encapsulating non-ASCII parts in base64 or quoted-printable

‎Doc/library/functions.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1393,7 +1393,7 @@ are always available. They are listed here in alphabetical order.
13931393
supported.
13941394

13951395

1396-
.. function:: print(*objects, sep=' ', end='\\n', file=sys.stdout, flush=False)
1396+
.. function:: print(*objects, sep=' ', end='\n', file=sys.stdout, flush=False)
13971397

13981398
Print *objects* to the text stream *file*, separated by *sep* and followed
13991399
by *end*. *sep*, *end*, *file*, and *flush*, if present, must be given as keyword

‎Doc/library/http.cookies.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ Cookie Objects
9393
:meth:`value_decode` are inverses on the range of *value_decode*.
9494

9595

96-
.. method:: BaseCookie.output(attrs=None, header='Set-Cookie:', sep='\\r\\n')
96+
.. method:: BaseCookie.output(attrs=None, header='Set-Cookie:', sep='\r\n')
9797

9898
Return a string representation suitable to be sent as HTTP headers. *attrs* and
9999
*header* are sent to each :class:`Morsel`'s :meth:`output` method. *sep* is used

‎Doc/library/io.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1042,7 +1042,7 @@ Text I/O
10421042
The method supports ``encoding="locale"`` option.
10431043

10441044

1045-
.. class:: StringIO(initial_value='', newline='\\n')
1045+
.. class:: StringIO(initial_value='', newline='\n')
10461046

10471047
A text stream using an in-memory text buffer. It inherits
10481048
:class:`TextIOBase`.

‎Doc/library/xml.dom.minidom.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -180,7 +180,7 @@ module documentation. This section lists the differences between the API and
180180
.. versionchanged:: 3.9
181181
The *standalone* parameter was added.
182182

183-
.. method:: Node.toprettyxml(indent="\\t", newl="\\n", encoding=None, \
183+
.. method:: Node.toprettyxml(indent="\t", newl="\n", encoding=None, \
184184
standalone=None)
185185

186186
Return a pretty-printed version of the document. *indent* specifies the

‎Doc/tools/extensions/pyspecific.py‎

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -418,12 +418,7 @@ def run(self):
418418
translatable=False)
419419
node.append(para)
420420
env = self.state.document.settings.env
421-
# deprecated pre-Sphinx-2 method
422-
if hasattr(env, 'note_versionchange'):
423-
env.note_versionchange('deprecated', version[0], node, self.lineno)
424-
# new method
425-
else:
426-
env.get_domain('changeset').note_changeset(node)
421+
env.get_domain('changeset').note_changeset(node)
427422
return [node] + messages
428423

429424

0 commit comments

Comments
 (0)