duplicate label warnings in 5.2.0 #10870
Labels
Comments
vincentkfu
added a commit
to vincentkfu/fio
that referenced
this issue
Sep 27, 2022
Sphinx prints warnings when it encounters duplicate labels. In HOWTO.rst are labels for int, irange, and bool. We include HOWTO.rst in both fio_doc.rst and fio_man.rst. Since labels must be unique across all files, Sphinx prints warnings for these labels. For an unknown reason, Sphinx previously did not issue warnings for the duplicate labels mentioned above until 5.2.0. But Sphinx 5.2.1 is now installed for the macOS 11 image in GitHub Actions. So now we see Sphinx warnings when building documentation in GitHub Actions. Our CI treats Sphinx warnings as test failures. So our macOS builds are marked as failures. Resolve this problem by eliminating the separate fio_man.rst file and just building the manpage from the largely equivalent fio_doc.rst. Successful build with 5.1.1: https://github.com/axboe/fio/actions/runs/3106980788/jobs/5034529793 Failed build with 5.2.1: https://github.com/axboe/fio/actions/runs/3129974184/jobs/5079696775 Link: sphinx-doc/sphinx#10781 Link: sphinx-doc/sphinx#10870 Signed-off-by: Vincent Fu <vincent.fu@samsung.com>
axboe
pushed a commit
to axboe/fio
that referenced
this issue
Sep 27, 2022
Sphinx prints warnings when it encounters duplicate labels. In HOWTO.rst are labels for int, irange, and bool. We include HOWTO.rst in both fio_doc.rst and fio_man.rst. Since labels must be unique across all files, Sphinx prints warnings for these labels. For an unknown reason, Sphinx previously did not issue warnings for the duplicate labels mentioned above until 5.2.0. But Sphinx 5.2.1 is now installed for the macOS 11 image in GitHub Actions. So now we see Sphinx warnings when building documentation in GitHub Actions. Our CI treats Sphinx warnings as test failures. So our macOS builds are marked as failures. Resolve this problem by eliminating the separate fio_man.rst file and just building the manpage from the largely equivalent fio_doc.rst. Successful build with 5.1.1: https://github.com/axboe/fio/actions/runs/3106980788/jobs/5034529793 Failed build with 5.2.1: https://github.com/axboe/fio/actions/runs/3129974184/jobs/5079696775 Link: sphinx-doc/sphinx#10781 Link: sphinx-doc/sphinx#10870 Signed-off-by: Vincent Fu <vincent.fu@samsung.com>
|
I was able to restructure our document build to avoid duplicate labels. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Describe the bug
Starting with sphinx 5.2.0 duplicate label warnings now appear
How to Reproduce
Expected behavior
No warnings should appear as in 5.1.1
Your project
https://github.com/vincentkfu/sphinx-issue
Screenshots
No warnings in 5.1.1
Warning in 5.2.0
OS
Ubuntu 20.04
Python version
3.8
Sphinx version
5.2.0
Sphinx extensions
No response
Extra tools
No response
Additional context
Appears related to #10781
This was observed when the GitHub actions macOS 11 image started providing Sphinx 5.2.1:
https://github.com/axboe/fio/actions/runs/3129974184/jobs/5079696775
We fail our documentation build when warnings are seen. So our CI now fails with Sphinx 5.2.1 when it used to work with Sphinx 5.1.1.
Working Sphinx 5.1.1 build: https://github.com/axboe/fio/actions/runs/3106980788/jobs/5034529793
@jbms @AA-Turner
Perhaps the path forward is to suppress the warning as suggested by @jbms
The text was updated successfully, but these errors were encountered: