mirror of
https://github.com/python/cpython.git
synced 2025-09-27 02:39:58 +00:00
bpo-40204: Add :noindex: in the documentation (GH-21859)
Add :noindex: to duplicated documentation to fix "duplicate object description" errors. For example, fix this Sphinx 3 issue: Doc/library/configparser.rst:1146: WARNING: duplicate object description of configparser.ConfigParser.optionxform, other instance in library/configparser, use :noindex: for one of them
This commit is contained in:
parent
20ae565bd2
commit
d3ded08048
9 changed files with 88 additions and 75 deletions
|
@ -208,6 +208,7 @@ number of frames must be filled in.
|
||||||
|
|
||||||
|
|
||||||
.. method:: aifc.tell()
|
.. method:: aifc.tell()
|
||||||
|
:noindex:
|
||||||
|
|
||||||
Return the current write position in the output file. Useful in combination
|
Return the current write position in the output file. Useful in combination
|
||||||
with :meth:`setmark`.
|
with :meth:`setmark`.
|
||||||
|
@ -232,6 +233,7 @@ number of frames must be filled in.
|
||||||
|
|
||||||
|
|
||||||
.. method:: aifc.close()
|
.. method:: aifc.close()
|
||||||
|
:noindex:
|
||||||
|
|
||||||
Close the AIFF file. The header of the file is updated to reflect the actual
|
Close the AIFF file. The header of the file is updated to reflect the actual
|
||||||
size of the audio data. After calling this method, the object can no longer be
|
size of the audio data. After calling this method, the object can no longer be
|
||||||
|
|
|
@ -696,6 +696,7 @@ be overridden by subclasses or by attribute assignment.
|
||||||
``enabled``/``disabled``.
|
``enabled``/``disabled``.
|
||||||
|
|
||||||
.. method:: ConfigParser.optionxform(option)
|
.. method:: ConfigParser.optionxform(option)
|
||||||
|
:noindex:
|
||||||
|
|
||||||
This method transforms option names on every read, get, or set
|
This method transforms option names on every read, get, or set
|
||||||
operation. The default converts the name to lowercase. This also
|
operation. The default converts the name to lowercase. This also
|
||||||
|
|
|
@ -24,6 +24,7 @@ diffs. For comparing directories and files, see also, the :mod:`filecmp` module.
|
||||||
|
|
||||||
|
|
||||||
.. class:: SequenceMatcher
|
.. class:: SequenceMatcher
|
||||||
|
:noindex:
|
||||||
|
|
||||||
This is a flexible class for comparing pairs of sequences of any type, so long
|
This is a flexible class for comparing pairs of sequences of any type, so long
|
||||||
as the sequence elements are :term:`hashable`. The basic algorithm predates, and is a
|
as the sequence elements are :term:`hashable`. The basic algorithm predates, and is a
|
||||||
|
@ -651,6 +652,7 @@ The :class:`Differ` class has this constructor:
|
||||||
|
|
||||||
|
|
||||||
.. class:: Differ(linejunk=None, charjunk=None)
|
.. class:: Differ(linejunk=None, charjunk=None)
|
||||||
|
:noindex:
|
||||||
|
|
||||||
Optional keyword parameters *linejunk* and *charjunk* are for filter functions
|
Optional keyword parameters *linejunk* and *charjunk* are for filter functions
|
||||||
(or ``None``):
|
(or ``None``):
|
||||||
|
|
|
@ -50,6 +50,7 @@ helper, :class:`auto`.
|
||||||
the bitwise operations without losing their :class:`Flag` membership.
|
the bitwise operations without losing their :class:`Flag` membership.
|
||||||
|
|
||||||
.. function:: unique
|
.. function:: unique
|
||||||
|
:noindex:
|
||||||
|
|
||||||
Enum class decorator that ensures only one name is bound to any one value.
|
Enum class decorator that ensures only one name is bound to any one value.
|
||||||
|
|
||||||
|
|
|
@ -1695,7 +1695,9 @@ to sockets.
|
||||||
|
|
||||||
.. method:: socket.setsockopt(level, optname, value: int)
|
.. method:: socket.setsockopt(level, optname, value: int)
|
||||||
.. method:: socket.setsockopt(level, optname, value: buffer)
|
.. method:: socket.setsockopt(level, optname, value: buffer)
|
||||||
|
:noindex:
|
||||||
.. method:: socket.setsockopt(level, optname, None, optlen: int)
|
.. method:: socket.setsockopt(level, optname, None, optlen: int)
|
||||||
|
:noindex:
|
||||||
|
|
||||||
.. index:: module: struct
|
.. index:: module: struct
|
||||||
|
|
||||||
|
|
|
@ -151,6 +151,7 @@ Some facts and figures:
|
||||||
|
|
||||||
|
|
||||||
.. class:: TarFile
|
.. class:: TarFile
|
||||||
|
:noindex:
|
||||||
|
|
||||||
Class for reading and writing tar archives. Do not use this class directly:
|
Class for reading and writing tar archives. Do not use this class directly:
|
||||||
use :func:`tarfile.open` instead. See :ref:`tarfile-objects`.
|
use :func:`tarfile.open` instead. See :ref:`tarfile-objects`.
|
||||||
|
|
|
@ -70,6 +70,7 @@ the :mod:`tokenize` module.
|
||||||
|
|
||||||
|
|
||||||
.. data:: TYPE_COMMENT
|
.. data:: TYPE_COMMENT
|
||||||
|
:noindex:
|
||||||
|
|
||||||
Token value indicating that a type comment was recognized. Such
|
Token value indicating that a type comment was recognized. Such
|
||||||
tokens are only produced when :func:`ast.parse()` is invoked with
|
tokens are only produced when :func:`ast.parse()` is invoked with
|
||||||
|
|
|
@ -1069,6 +1069,7 @@ More drawing control
|
||||||
~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
.. function:: reset()
|
.. function:: reset()
|
||||||
|
:noindex:
|
||||||
|
|
||||||
Delete the turtle's drawings from the screen, re-center the turtle and set
|
Delete the turtle's drawings from the screen, re-center the turtle and set
|
||||||
variables to the default values.
|
variables to the default values.
|
||||||
|
@ -1090,6 +1091,7 @@ More drawing control
|
||||||
|
|
||||||
|
|
||||||
.. function:: clear()
|
.. function:: clear()
|
||||||
|
:noindex:
|
||||||
|
|
||||||
Delete the turtle's drawings from the screen. Do not move turtle. State and
|
Delete the turtle's drawings from the screen. Do not move turtle. State and
|
||||||
position of the turtle as well as drawings of other turtles are not affected.
|
position of the turtle as well as drawings of other turtles are not affected.
|
||||||
|
@ -1362,6 +1364,7 @@ Using events
|
||||||
------------
|
------------
|
||||||
|
|
||||||
.. function:: onclick(fun, btn=1, add=None)
|
.. function:: onclick(fun, btn=1, add=None)
|
||||||
|
:noindex:
|
||||||
|
|
||||||
:param fun: a function with two arguments which will be called with the
|
:param fun: a function with two arguments which will be called with the
|
||||||
coordinates of the clicked point on the canvas
|
coordinates of the clicked point on the canvas
|
||||||
|
|
|
@ -946,7 +946,7 @@ tracking URIs for which authentication credentials should always be sent.
|
||||||
If *is_authenticated* is specified as ``True``, *realm* is ignored.
|
If *is_authenticated* is specified as ``True``, *realm* is ignored.
|
||||||
|
|
||||||
|
|
||||||
.. method:: HTTPPasswordMgr.find_user_password(realm, authuri)
|
.. method:: HTTPPasswordMgrWithPriorAuth.find_user_password(realm, authuri)
|
||||||
|
|
||||||
Same as for :class:`HTTPPasswordMgrWithDefaultRealm` objects
|
Same as for :class:`HTTPPasswordMgrWithDefaultRealm` objects
|
||||||
|
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue