From: Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Date: Tue, 16 Oct 2018 06:47:07 +0000 (-0700)
Subject: bpo-34967: Sphinx is deprecating add_description_unit, use add_object_type (GH-9827)
X-Git-Tag: v3.6.8rc1~224
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=e2c3bc7e79c3506609845f7f62ba102e6c7e9993;p=thirdparty%2FPython%2Fcpython.git

bpo-34967: Sphinx is deprecating add_description_unit, use add_object_type (GH-9827)

(cherry picked from commit e385d0661ecf8bc9ba95c4395d9a11262c2cbfec)

Co-authored-by: Stéphane Wirtel <stephane@wirtel.be>
---

diff --git a/Doc/tools/extensions/pyspecific.py b/Doc/tools/extensions/pyspecific.py
index 02e7a132d490..5b2c31563766 100644
--- a/Doc/tools/extensions/pyspecific.py
+++ b/Doc/tools/extensions/pyspecific.py
@@ -388,11 +388,9 @@ def setup(app):
     app.add_directive('deprecated-removed', DeprecatedRemoved)
     app.add_builder(PydocTopicsBuilder)
     app.add_builder(suspicious.CheckSuspiciousMarkupBuilder)
-    app.add_description_unit('opcode', 'opcode', '%s (opcode)',
-                             parse_opcode_signature)
-    app.add_description_unit('pdbcommand', 'pdbcmd', '%s (pdb command)',
-                             parse_pdb_command)
-    app.add_description_unit('2to3fixer', '2to3fixer', '%s (2to3 fixer)')
+    app.add_object_type('opcode', 'opcode', '%s (opcode)', parse_opcode_signature)
+    app.add_object_type('pdbcommand', 'pdbcmd', '%s (pdb command)', parse_pdb_command)
+    app.add_object_type('2to3fixer', '2to3fixer', '%s (2to3 fixer)')
     app.add_directive_to_domain('py', 'decorator', PyDecoratorFunction)
     app.add_directive_to_domain('py', 'decoratormethod', PyDecoratorMethod)
     app.add_directive_to_domain('py', 'coroutinefunction', PyCoroutineFunction)
diff --git a/Misc/NEWS.d/next/Documentation/2018-10-13-07-39-57.bpo-34967.E40tFP.rst b/Misc/NEWS.d/next/Documentation/2018-10-13-07-39-57.bpo-34967.E40tFP.rst
new file mode 100644
index 000000000000..6341296663ae
--- /dev/null
+++ b/Misc/NEWS.d/next/Documentation/2018-10-13-07-39-57.bpo-34967.E40tFP.rst
@@ -0,0 +1,2 @@
+Use app.add_object_type() instead of the deprecated Sphinx function
+app.description_unit()