Skip to content

Commit ac4bba7

Browse files
committed
fix: add MdRenderer concretes for new Docstring types
1 parent 67c8e53 commit ac4bba7

File tree

1 file changed

+16
-4
lines changed

1 file changed

+16
-4
lines changed

quartodoc/renderers.py

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -269,13 +269,25 @@ def render(self, el: ds.DocstringAttribute):
269269
annotation = self._render_annotation(el.annotation)
270270
return el.name, self.render(annotation), el.description
271271

272+
# warnings ----
273+
274+
@dispatch
275+
def render(self, el: qast.DocstringSectionWarnings):
276+
return el.value
277+
272278
# see also ----
273279

274280
@dispatch
275281
def render(self, el: qast.DocstringSectionSeeAlso):
276282
# TODO: attempt to parse See Also sections
277283
return convert_rst_link_to_md(el.value)
278284

285+
# notes ----
286+
287+
@dispatch
288+
def render(self, el: qast.DocstringSectionNotes):
289+
return el.value
290+
279291
# examples ----
280292

281293
@dispatch
@@ -290,6 +302,10 @@ def render(self, el: qast.ExampleCode):
290302
{el.value}
291303
```"""
292304

305+
@dispatch
306+
def render(self, el: qast.ExampleText):
307+
return el.value
308+
293309
# returns ----
294310

295311
@dispatch
@@ -306,10 +322,6 @@ def render(self, el: Union[ds.DocstringReturn, ds.DocstringRaise]):
306322

307323
# unsupported parts ----
308324

309-
@dispatch
310-
def render(self, el: qast.ExampleText):
311-
return el.value
312-
313325
@dispatch.multi(
314326
(ds.DocstringAdmonition,),
315327
(ds.DocstringDeprecated,),

0 commit comments

Comments
 (0)