Merge pull request #6 from florimondmanca/feat/async-marker

Display async keyword in front of async functions/methods

mkautodoc/extension.py

@@ -182,6 +182,9 @@ def render_signature(
         if inspect.isclass(item):
             qualifier_elem = etree.SubElement(signature_elem, "em")
             qualifier_elem.text = "class "
+        elif inspect.iscoroutinefunction(item):
+            qualifier_elem = etree.SubElement(signature_elem, "em")
+            qualifier_elem.text = "async "
 
         name_elem = etree.SubElement(signature_elem, "code")
         if module_string:

tests/mocklib/mocklib.py

@@ -24,3 +24,9 @@ def example_property(self):
         """
         This is a property with a *docstring*.
         """
+
+
+async def example_async_function():
+    """
+    This is a coroutine function as can be seen by the *async* keyword.
+    """

tests/test_extension.py

@@ -18,6 +18,18 @@ def test_docstring():
     ]
 
 
+def test_async_function():
+    content = """
+::: mocklib.example_async_function
+"""
+    output = markdown.markdown(content, extensions=["mkautodoc"])
+    assert output.splitlines() == [
+        '<div class="autodoc">',
+        '<div class="autodoc-signature"><em>async </em><code>mocklib.<strong>example_async_function</strong></code><span class="autodoc-punctuation">(</span><span class="autodoc-punctuation">)</span></div>',
+        "</div>",
+    ]
+
+
 def test_members():
     content = """
 # Example