summaryrefslogtreecommitdiffstats
path: root/Doc/library/tarfile.rst
diff options
context:
space:
mode:
authorVictor Stinner <vstinner@python.org>2020-08-13 19:41:54 (GMT)
committerGitHub <noreply@github.com>2020-08-13 19:41:54 (GMT)
commitd3ded080482beae578faa704b13534a62d066f9f (patch)
tree7ca864cdf5ebac68481f2c794725df7df2519210 /Doc/library/tarfile.rst
parent20ae565bd2d79425d5567c001ed8f89848d7d907 (diff)
downloadcpython-d3ded080482beae578faa704b13534a62d066f9f.zip
cpython-d3ded080482beae578faa704b13534a62d066f9f.tar.gz
cpython-d3ded080482beae578faa704b13534a62d066f9f.tar.bz2
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
Diffstat (limited to 'Doc/library/tarfile.rst')
-rw-r--r--Doc/library/tarfile.rst1
1 files changed, 1 insertions, 0 deletions
diff --git a/Doc/library/tarfile.rst b/Doc/library/tarfile.rst
index c204263..cca466b 100644
--- a/Doc/library/tarfile.rst
+++ b/Doc/library/tarfile.rst
@@ -151,6 +151,7 @@ Some facts and figures:
.. class:: TarFile
+ :noindex:
Class for reading and writing tar archives. Do not use this class directly:
use :func:`tarfile.open` instead. See :ref:`tarfile-objects`.