Vishesh 'ironeagle' Bangotra
06ffd2febd
Squash-merge lib-standardisation: adopt repo standards across packaging, tooling, docs, and CI. - standardize pyproject.toml (canonical packaging, lint config, extras, GSDFC pydoclint) - add py.typed marker, modernize type hints and Google-style docstrings - nest generated docs under docs/lib and docs/mcp; add hand-written wiki - adopt standard Type A PyPI CI pipeline (tag==version guard + quality gate) - promote generated CHANGELOG.md; bump version to 0.0.7
32 lines
870 B
Python
32 lines
870 B
Python
from pathlib import Path
|
|
|
|
from docforge.models import Module, Project
|
|
|
|
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: Project, out_dir: Path) -> None: ...
|
|
def _ensure_parent_index(
|
|
self, parts: list[str], out_dir: Path, link_target: str, title: str
|
|
) -> None: ...
|