google styled doc string and create README.md using package doc string

2026-02-28 19:56:58 +05:30
parent f8ca6075fb
commit 219d6f9f87
9 changed files with 212 additions and 41 deletions
--- a/docforge/renderers/mkdocs_renderer.pyi
+++ b/docforge/renderers/mkdocs_renderer.pyi
@@ -12,6 +12,13 @@ class MkDocsRenderer:
        module_is_source: bool | None = None,
    ) -> None: ...

+    def generate_readme(
+        self,
+        project: Project,
+        docs_dir: Path,
+        module_is_source: bool | None = None,
+    ) -> None:
+
    def _write_module(
        self,
        module: Module,