Skip to content

Commit a98bf47

Browse files
committed
fix: use shortname for member children linked style
1 parent 4739a4e commit a98bf47

File tree

3 files changed

+29
-2
lines changed

3 files changed

+29
-2
lines changed

quartodoc/renderers/md_renderer.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -768,7 +768,7 @@ def summarize(
768768
@dispatch
769769
def summarize(self, el: layout.Link):
770770
description = self.summarize(el.obj)
771-
return self._summary_row(f"[](`{el.name}`)", description)
771+
return self._summary_row(f"[](`~{el.name}`)", description)
772772

773773
@dispatch
774774
def summarize(self, obj: Union[dc.Object, dc.Alias]) -> str:

quartodoc/tests/__snapshots__/test_renderers.ambr

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -314,6 +314,33 @@
314314
A function
315315
'''
316316
# ---
317+
# name: test_render_doc_module[linked]
318+
'''
319+
# quartodoc.tests.example { #quartodoc.tests.example }
320+
321+
`tests.example`
322+
323+
A module
324+
325+
## Attributes
326+
327+
| Name | Description |
328+
| --- | --- |
329+
| [](`~quartodoc.tests.example.a_attr`) | An attribute |
330+
331+
## Classes
332+
333+
| Name | Description |
334+
| --- | --- |
335+
| [](`~quartodoc.tests.example.AClass`) | A class |
336+
337+
## Functions
338+
339+
| Name | Description |
340+
| --- | --- |
341+
| [](`~quartodoc.tests.example.a_func`) | A function |
342+
'''
343+
# ---
317344
# name: test_render_doc_signature_name
318345
'''
319346
# example.a_func { #quartodoc.tests.example.a_func }

quartodoc/tests/test_renderers.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ def test_render_doc_section_admonition(renderer):
126126
assert res == "quartodoc.tests.example: Method for doing a thing"
127127

128128

129-
@pytest.mark.parametrize("children", ["embedded", "flat"])
129+
@pytest.mark.parametrize("children", ["embedded", "flat", "linked"])
130130
def test_render_doc_module(snapshot, renderer, children):
131131
bp = blueprint(Auto(name="quartodoc.tests.example", children=children))
132132
res = renderer.render(bp)

0 commit comments

Comments
 (0)