Sphinx duplicate label warning in docs

[tirkarthi]

BPO	34081
Nosy	@JulienPalard, @tirkarthi
PRs	bpo-34081: Fix wrong example link that was linking to distutils #8248

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = None
closed_at = <Date 2018-10-21.14:55:20.084>
created_at = <Date 2018-07-10.08:32:01.352>
labels = ['3.8', 'docs']
title = 'Sphinx duplicate label warning in docs'
updated_at = <Date 2018-10-21.14:55:20.084>
user = 'https://github.com/tirkarthi'

bugs.python.org fields:

activity = <Date 2018-10-21.14:55:20.084>
actor = 'mdk'
assignee = 'docs@python'
closed = True
closed_date = <Date 2018-10-21.14:55:20.084>
closer = 'mdk'
components = ['Documentation']
creation = <Date 2018-07-10.08:32:01.352>
creator = 'xtreak'
dependencies = []
files = []
hgrepos = []
issue_num = 34081
keywords = ['patch']
message_count = 2.0
messages = ['321368', '328215']
nosy_count = 3.0
nosy_names = ['docs@python', 'mdk', 'xtreak']
pr_nums = ['8248']
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = None
url = 'https://bugs.python.org/issue34081'
versions = ['Python 3.8']

[tirkarthi]

While running make docs sphinx generates a warning that there are duplicate labels named _examples. It seems it's present in c-api/typeobj.rst and distutils/examples.rst as below :

➜ Doc git:(master) rg '.. _examples:'
c-api/typeobj.rst
2324:.. _examples:

distutils/examples.rst
1:.. _examples:

# Warning

2018-07-10T07:30:36.8709047Z /opt/vsts/work/1/s/Doc/distutils/examples.rst:5: WARNING: duplicate label examples, other instance in /opt/vsts/work/1/s/Doc/c-api/typeobj.rst

Sample log : https://python.visualstudio.com/cpython/cpython%20Team/_build/results?buildId=16141&view=logs

There are no references to the label as far as I have checked and I suppose this is an easy fix to be done if someone wants to take it up. The effect is that in the page https://docs.python.org/3.8/c-api/typeobj.html the following text links to distutils/examples for the text "Examples" which should ideally link to https://docs.python.org/3.8/c-api/typeobj.html#examples

"In addition to the following quick reference, the Examples section provides at-a-glance insight into the meaning and use of PyTypeObject."

It will be also helpful if sphinx warnings are made as an error in CI so that these are caught there.

Thanks

[JulienPalard]

New changeset 121eb16 by Julien Palard (Xtreak) in branch 'master':
bpo-34081: Fix wrong example link that was linking to distutils (GH-8248)
121eb16