feat: Add parameter to prevent formatting Markdown with mdformat

Issue-18: #18

Author: pawamoy

src/griffe2md/_internal/main.py

@@ -116,12 +116,13 @@ def prepare_env(env: Environment | None = None) -> Environment:
     return env
 
 
-def render_object_docs(obj: Object, config: ConfigDict | None = None) -> str:
+def render_object_docs(obj: Object, config: ConfigDict | None = None, *, format_md: bool = True) -> str:
     """Render docs for a given object.
 
     Parameters:
         obj: The Griffe object to render docs for.
         config: The rendering configuration.
+        format_md: Whether to format the resulting Markdown.
 
     Warning:
         When using this function programmatically,
@@ -135,15 +136,22 @@ def render_object_docs(obj: Object, config: ConfigDict | None = None) -> str:
     env = prepare_env()
     context = prepare_context(obj, config)
     rendered = env.get_template(f"{obj.kind.value}.md.jinja").render(**context)
-    return mdformat.text(rendered)
+    if format_md:
+        rendered = mdformat.text(
+            rendered,
+            options={"number": "yes", "wrap": "no"},
+            extensions=("tables",),
+        )
+    return rendered
 
 
-def render_package_docs(package: str, config: ConfigDict | None = None) -> str:
+def render_package_docs(package: str, config: ConfigDict | None = None, *, format_md: bool = True) -> str:
     """Render docs for a given package.
 
     Parameters:
         package: The package (name) to render docs for.
         config: The rendering configuration.
+        format_md: Whether to format the resulting Markdown.
 
     Returns:
         Markdown.
@@ -162,19 +170,22 @@ def render_package_docs(package: str, config: ConfigDict | None = None) -> str:
     )
     module = loader.load(package)
     loader.resolve_aliases(external=True)
-    return render_object_docs(module, config)  # type: ignore[arg-type]
+    return render_object_docs(module, config, format_md=format_md)  # type: ignore[arg-type]
 
 
 def write_package_docs(
     package: str,
     config: ConfigDict | None = None,
     output: IO | str | None = None,
+    *,
+    format_md: bool = True,
 ) -> None:
     """Write docs for a given package to a file or stdout.
 
     Parameters:
         package: The package to render docs for.
         config: The rendering configuration.
         output: The file to write to.
+        format_md: Whether to format the resulting Markdown.
     """
-    _output(render_package_docs(package, config), to=output)
+    _output(render_package_docs(package, config, format_md=format_md), to=output)