try again

Author: deven367

src/griffe2md/_internal/cli.py

@@ -73,5 +73,5 @@ def main(args: list[str] | None = None) -> int:
     if opts.mdformat_extensions:
         config = cast("ConfigDict", {**(config or {}), "mdformat_extensions": opts.mdformat_extensions})
 
-    write_package_docs(opts.package, config, opts.output)
+    write_package_docs(opts.package, config, opts.output, format_md=opts.format_md)
     return 0

src/griffe2md/_internal/main.py

@@ -116,7 +116,7 @@ def prepare_env(env: Environment | None = None) -> Environment:
     return env
 
 
-def render_object_docs(obj: Object, config: ConfigDict | None = None, *, format_md: bool = False) -> str:
+def render_object_docs(obj: Object, config: ConfigDict | None = None, *, format_md: bool = True) -> str:
     """Render docs for a given object.
 
     Parameters:
@@ -143,7 +143,7 @@ def render_object_docs(obj: Object, config: ConfigDict | None = None, *, format_
     return rendered
 
 
-def render_package_docs(package: str, config: ConfigDict | None = None, *, format_md: bool = False) -> str:
+def render_package_docs(package: str, config: ConfigDict | None = None, *, format_md: bool = True) -> str:
     """Render docs for a given package.
 
     Parameters:
@@ -176,7 +176,7 @@ def write_package_docs(
     config: ConfigDict | None = None,
     output: IO | str | None = None,
     *,
-    format_md: bool = False,
+    format_md: bool = True,
 ) -> None:
     """Write docs for a given package to a file or stdout.
 

tests/test_markdown_spacing.py

@@ -2,13 +2,13 @@
 
 from __future__ import annotations
 
-from typing import TYPE_CHECKING, Any
+from typing import TYPE_CHECKING, Any, cast
 
 import griffe
 import pytest
 from griffe import GriffeLoader, Parser
 
-from griffe2md import render_object_docs
+from griffe2md import ConfigDict, render_object_docs
 
 if TYPE_CHECKING:
     from griffe._internal.models import Module
@@ -74,14 +74,17 @@ def _render(**kwargs: Any) -> str:
 
     return render_object_docs(
         module,
-        {
-            "show_root_full_path": False,
-            "show_root_members_full_path": False,
-            "show_object_full_path": False,
-            "show_category_heading": False,
-            "show_signature": True,
-            **kwargs,
-        },
+        cast(
+            "ConfigDict",
+            {
+                "show_root_full_path": False,
+                "show_root_members_full_path": False,
+                "show_object_full_path": False,
+                "show_category_heading": False,
+                "show_signature": True,
+                **kwargs,
+            },
+        ),
         format_md=False,
     )