Only complain about duplicate labels when the non-prefixed keys are different. (#366)

Closes #365

Author: mcmtroffaes

CHANGELOG.rst

@@ -16,6 +16,11 @@
 * Bib files in conf.py are now resolved relative to confdir instead of srcdir
   (reported and fixed by rgambord, see issue #357 and pull request #358).
 
+* Duplicate label warnings are no longer issued if the non-prefixed keys
+  are identical. This allows having duplicate citations,
+  as long as the keys are differently prefixed, which is a common use case.
+  See issue #365 reported by ego-thales.
+
 2.6.3 (12 September 2024)
 -------------------------
 

src/sphinxcontrib/bibtex/domain.py

@@ -380,16 +380,16 @@ def env_updated(self) -> Iterable[str]:
                 if bibliography.list_ == "citation":
                     used_keys.add(key)
                     if formatted_entry.label not in used_labels:
-                        used_labels[formatted_entry.label] = key
-                    elif used_labels[formatted_entry.label] != key:
+                        used_labels[formatted_entry.label] = formatted_entry.key
+                    elif used_labels[formatted_entry.label] != formatted_entry.key:
                         # if used_label[label] == key then already
                         # duplicate key warning
                         logger.warning(
                             'duplicate label "%s" for keys "%s" and "%s"'
                             % (
                                 formatted_entry.label,
                                 used_labels[formatted_entry.label],
-                                key,
+                                formatted_entry.key,
                             ),
                             location=(bibliography_key.docname, bibliography.line),
                             type="bibtex",

test/roots/test-duplicate_label_2/conf.py

@@ -0,0 +1,3 @@
+extensions = ["sphinxcontrib.bibtex"]
+exclude_patterns = ["_build"]
+bibtex_bibfiles = ["test.bib"]

test/roots/test-duplicate_label_2/doc1.rst

@@ -0,0 +1,6 @@
+Doc1
+====
+
+.. bibliography:: test.bib
+   :keyprefix: doc1-
+   :all:

test/roots/test-duplicate_label_2/doc2.rst

@@ -0,0 +1,6 @@
+Doc2
+====
+
+.. bibliography:: test.bib
+   :keyprefix: doc2-
+   :all:

test/roots/test-duplicate_label_2/index.rst

@@ -0,0 +1,7 @@
+Contents
+========
+
+.. toctree::
+
+   doc1
+   doc2

test/roots/test-duplicate_label_2/test.bib

@@ -0,0 +1,4 @@
+@Misc{Test,
+  author =    {Mr. Test},
+  title =     {Test},
+}

test/test_duplicate.py

@@ -16,6 +16,17 @@ def test_duplicate_label(app, warning) -> None:
     assert html_citations(label="1").search(output2)
 
 
+@pytest.mark.sphinx("html", testroot="duplicate_label_2")
+def test_duplicate_label_2(app, warning) -> None:
+    # see github issue #365
+    app.build()
+    assert not warning.getvalue()
+    output = (app.outdir / "doc1.html").read_text()
+    output2 = (app.outdir / "doc2.html").read_text()
+    assert html_citations(label="Tes").search(output)
+    assert html_citations(label="Tes").search(output2)
+
+
 @pytest.mark.sphinx("html", testroot="duplicate_citation")
 def test_duplicate_citation(app, warning) -> None:
     app.build()