fix: renderer now supports admonitions

Author: machow

quartodoc/renderers/md_renderer.py

@@ -508,7 +508,7 @@ def render(self, el: ds.DocstringSectionAdmonition):
             # TODO: attempt to parse See Also sections
             return convert_rst_link_to_md(el.value.description)
 
-        raise NotImplementedError(f"Unsupported DocstringSectionAdmonition kind: {kind}")
+        return el.value.description
 
     # warnings ----
 

quartodoc/tests/__snapshots__/test_renderers.ambr

@@ -307,6 +307,10 @@
   |--------|--------|------------------|------------|
   | `a`    | int    | The a parameter. | _required_ |
   | `b`    | str    | The b parameter. | _required_ |
+  
+  ## Custom Admonition
+  
+  Some text.
   '''
 # ---
 # name: test_render_docstring_styles[numpy]
@@ -323,6 +327,10 @@
   |--------|--------|------------------|------------|
   | `a`    |        | The a parameter. | _required_ |
   | `b`    | str    | The b parameter. | _required_ |
+  
+  ## Custom Admonition
+  
+  Some text.
   '''
 # ---
 # name: test_render_docstring_styles[sphinx]

quartodoc/tests/example_docstring_styles.py

@@ -4,6 +4,9 @@ def f_google(a, b: str):
     Args:
         a (int): The a parameter.
         b: The b parameter.
+
+    Custom Admonition:
+        Some text.
     """
 
 
@@ -26,6 +29,9 @@ def f_numpy(a, b: str):
     b:
         The b parameter.
 
+    Custom Admonition
+    -----------------
+    Some text.
     """
 
 
@@ -41,5 +47,4 @@ def f_numpy_with_linebreaks(a, b: str):
 
     b:
         The b parameter.
-
     """