Fix #9205: py domain: canonical option causes xref resolution error

The :canonical: option causes "more than one target for cross-reference" warning because the class having the same name is registered.
sphinx-doc · May 10, 2021 · 41277e7 · 41277e7
1 parent d2c8cd3
commit 41277e7
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 0 deletions.
diff --git a/CHANGES b/CHANGES
@@ -22,6 +22,8 @@ Bugs fixed
   autosummary_generate
 * #8380: html search: tags for search result are broken
 * #9198: i18n: Babel emits errors when running compile_catalog
+* #9205: py domain: The :canonical: option causes "more than one target for
+  cross-reference" warning
 
 Testing
 --------

diff --git a/tests/roots/test-domain-py/canonical.rst b/tests/roots/test-domain-py/canonical.rst
@@ -0,0 +1,9 @@
+caninical
+=========
+
+:py:class:`.Foo`
+
+.. py:module:: canonical
+
+.. py:class:: Foo
+   :canonical: original.module.Foo