From: Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Date: Sat, 20 Jul 2024 19:54:57 +0000 (+0200)
Subject: [3.12] Docs: Fix duplicate object description warnings (GH-122068) (#122070)
X-Git-Tag: v3.12.5~73
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=0298da432dd1f8e95e7b4e652ad0123c2833711d;p=thirdparty%2FPython%2Fcpython.git

[3.12] Docs: Fix duplicate object description warnings (GH-122068) (#122070)

Docs: Fix duplicate object description warnings (GH-122068)
(cherry picked from commit 8db5f480072421bb065d346c3bbc5e88fc368587)

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

diff --git a/Doc/library/email.compat32-message.rst b/Doc/library/email.compat32-message.rst
index c4c322a82e1f..6e27a6e224a7 100644
--- a/Doc/library/email.compat32-message.rst
+++ b/Doc/library/email.compat32-message.rst
@@ -7,6 +7,7 @@
    :synopsis: The base class representing email messages in a fashion
               backward compatible with Python 3.2
    :noindex:
+   :no-index:
 
 
 The :class:`Message` class is very similar to the
diff --git a/Doc/library/xml.etree.elementtree.rst b/Doc/library/xml.etree.elementtree.rst
index 5f13f4696092..ef7f45461373 100644
--- a/Doc/library/xml.etree.elementtree.rst
+++ b/Doc/library/xml.etree.elementtree.rst
@@ -869,6 +869,7 @@ Element Objects
 
 .. module:: xml.etree.ElementTree
    :noindex:
+   :no-index:
 
 .. class:: Element(tag, attrib={}, **extra)
 
diff --git a/Doc/tools/extensions/pyspecific.py b/Doc/tools/extensions/pyspecific.py
index c50139b7b832..a9e00ab05713 100644
--- a/Doc/tools/extensions/pyspecific.py
+++ b/Doc/tools/extensions/pyspecific.py
@@ -18,11 +18,12 @@ from pprint import pformat
 import sphinx
 from docutils import nodes
 from docutils.io import StringOutput
+from docutils.parsers.rst import directives
 from docutils.utils import new_document, unescape
 from sphinx import addnodes
 from sphinx.builders import Builder
 from sphinx.domains.changeset import VersionChange, versionlabels, versionlabel_classes
-from sphinx.domains.python import PyFunction, PyMethod
+from sphinx.domains.python import PyFunction, PyMethod, PyModule
 from sphinx.errors import NoUri
 from sphinx.locale import _ as sphinx_gettext
 from sphinx.util import logging
@@ -49,6 +50,9 @@ from sphinx.domains import std
 
 std.token_re = re.compile(r'`((~?[\w-]*:)?\w+)`')
 
+# backport :no-index:
+PyModule.option_spec['no-index'] = directives.flag
+
 
 # Support for marking up and linking to bugs.python.org issues