Merge pull request #180 from machow/feat-canonical-collect

Feat canonical collect

Author: machow

quartodoc/builder/collect.py

@@ -39,10 +39,25 @@ def exit(self, el: layout.Doc):
         p_el = page_node.value
 
         uri = f"{self.base_dir}/{p_el.path}.html#{el.anchor}"
+
+        name_path = el.obj.path
+        canonical_path = el.obj.canonical_path
+
+        # item corresponding to the specified path ----
+        # e.g. this might be a top-level import
         self.items.append(
-            layout.Item(name=el.obj.path, obj=el.obj, uri=uri, dispname=None)
+            layout.Item(name=name_path, obj=el.obj, uri=uri, dispname=None)
         )
 
+        if name_path != canonical_path:
+            # item corresponding to the canonical path ----
+            # this is where the object is defined (which may be deep in a submodule)
+            self.items.append(
+                layout.Item(
+                    name=canonical_path, obj=el.obj, uri=uri, dispname=name_path
+                )
+            )
+
         return el
 
     @dispatch