diff options
| author | James Addison <jay@jp-hosting.net> | 2025-04-07 21:51:20 +0200 |
|---|---|---|
| committer | Jonathan Corbet <corbet@lwn.net> | 2025-04-14 10:22:46 -0600 |
| commit | 3fa3b20ba15cddc4462e64a79d779ad3b2d0d4e1 (patch) | |
| tree | 8dd1c0c5b841aac3f3fd86bbe7c7a8c3c4e7994e /scripts/lib/kdoc/kdoc_files.py | |
| parent | fb42d8dcbc3f01782b4df4ef2b69ec5a902d992e (diff) | |
docs: Disambiguate a pair of rST labels
According to the reStructuredText documentation, internal hyperlink
targets[1] are intended to resolve within the current document.
Sphinx has a bug that causes internal hyperlinks declared with
duplicate names to resolve nondeterministically, producing incorrect
documentation. Sphinx does not yet emit a warning when these
duplicate target names are declared.
To improve the reproducibility and correctness of the HTML
documentation, disambiguate two labels both previously titled
"submit_improvements".
[1] - https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#hyperlink-targets
Link: https://github.com/sphinx-doc/sphinx/issues/13383
Signed-off-by: James Addison <jay@jp-hosting.net>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/20250407195120.331103-2-jvanderwaa@redhat.com
Diffstat (limited to 'scripts/lib/kdoc/kdoc_files.py')
0 files changed, 0 insertions, 0 deletions