use anonymous references in changelog conversion (#1041)

hvac · Sep 4, 2023 · 8e2007e · 8e2007e
1 parent 0ae58b6
commit 8e2007e
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -33,6 +33,13 @@
     "autodocsumm",
 ]
 
+# https://github.com/CrossNox/m2r2/blob/0408d7acea843485d9ff42ee08a105a79f045493/m2r2.py#L675C27-L675C51
+# https://github.com/CrossNox/m2r2/issues/30
+# We use m2r primarily to convert the markdown changelog to RST, so we don't need named references.
+# Since we may have multiple changelog entries refer to the same GitHub issue, and we use the same text
+# to anchor it (GH-###), it would result in duplicate explicit target names.
+m2r_anonymous_references = True
+
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]