Merge pull request #281 from machow/fix-signature-when-alias

Fix signature when alias

Author: machow

quartodoc/renderers/md_renderer.py

@@ -163,7 +163,7 @@ def signature(self, el: layout.Doc):
     @dispatch
     def signature(self, el: dc.Alias, source: Optional[dc.Alias] = None):
         """Return a string representation of an object's signature."""
-        return self.signature(el.target, el)
+        return self.signature(el.final_target, el)
 
     @dispatch
     def signature(

quartodoc/tests/__snapshots__/test_renderers.ambr

@@ -268,6 +268,15 @@
   A function
   '''
 # ---
+# name: test_render_doc_signature_name_alias_of_alias
+  '''
+  # example.a_nested_alias { #quartodoc.tests.example.a_nested_alias }
+  
+  `tests.example.a_nested_alias()`
+  
+  A nested alias target
+  '''
+# ---
 # name: test_render_docstring_numpy_linebreaks
   '''
   # f_numpy_with_linebreaks { #quartodoc.tests.example_docstring_styles.f_numpy_with_linebreaks }

quartodoc/tests/example.py

@@ -2,7 +2,10 @@
 
 # flake8: noqa
 
-from quartodoc.tests.example_alias_target import alias_target as a_alias
+from quartodoc.tests.example_alias_target import (
+    alias_target as a_alias,
+    nested_alias_target as a_nested_alias,
+)
 
 
 def a_func():

quartodoc/tests/example_alias_target.py

@@ -1,2 +1,7 @@
+from quartodoc.tests.example_alias_target__nested import (  # noqa: F401
+    nested_alias_target,
+)
+
+
 def alias_target():
     """An alias target"""

quartodoc/tests/example_alias_target__nested.py

@@ -0,0 +1,7 @@
+"""
+This function gets imported in example_alias_target, and from there imported into example.
+"""
+
+
+def nested_alias_target():
+    """A nested alias target"""

quartodoc/tests/test_builder_blueprint.py

@@ -133,8 +133,8 @@ def test_blueprint_auto_package(bp):
     assert sections[0].title == "quartodoc.tests.example"
     assert sections[0].desc == "A module"
 
-    # 4 objects documented
-    assert len(sections[0].contents) == 4
+    # 5 objects documented
+    assert len(sections[0].contents) == 5
 
 
 def test_blueprint_layout_options():

quartodoc/tests/test_renderers.py

@@ -164,3 +164,12 @@ def test_render_doc_signature_name(snapshot, renderer):
     res = renderer.render(bp)
 
     assert res == snapshot
+
+
+def test_render_doc_signature_name_alias_of_alias(snapshot, renderer):
+    auto = Auto(name="example.a_nested_alias", package="quartodoc.tests")
+    bp = blueprint(auto)
+
+    res = renderer.render(bp)
+
+    assert res == snapshot