New submission from Karthikeyan Singaravelan <tir.kar...@gmail.com>:
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 ---------- assignee: docs@python components: Documentation messages: 321368 nosy: docs@python, xtreak priority: normal severity: normal status: open title: Sphinx duplicate label warning in docs versions: Python 3.8 _______________________________________ Python tracker <rep...@bugs.python.org> <https://bugs.python.org/issue34081> _______________________________________ _______________________________________________ Python-bugs-list mailing list Unsubscribe: https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
