from pathlib import Path
from docforge.models import Project, Module


class MkDocsRenderer:
    name: str

    def generate_sources(
        self,
        project: Project,
        out_dir: Path,
        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,
        packages: set[str],
        out_dir: Path,
        module_is_source: bool | None = None,
    ) -> None: ...

    def _render_markdown(self, title: str, module_path: str) -> str: ...

    def _ensure_root_index(self, project, out_dir) -> None: ...

    def _ensure_parent_index(self, parts, out_dir, link_target, title) -> None: ...