doc changes

docforge/cli/mkdocs_utils.py

@@ -9,6 +9,11 @@ from docforge.nav import load_nav_spec, resolve_nav, MkDocsNavEmitter
 def generate_sources(module: str, project_name: str | None, docs_dir: Path) -> None:
     """
     Generate Markdown source files for the specified module.
+
+    Args:
+        module: The dotted path of the primary module to document.
+        project_name: Optional override for the project name.
+        docs_dir: Directory where the generated Markdown files will be written.
     """
     loader = GriffeLoader()
     discovered_paths = discover_module_paths(module)
@@ -20,6 +25,13 @@ def generate_sources(module: str, project_name: str | None, docs_dir: Path) -> N
 def generate_config(docs_dir: Path, nav_file: Path, template: Path | None, out: Path, site_name: str) -> None:
     """
     Generate an mkdocs.yml configuration file.
+
+    Args:
+        docs_dir: Path to the directory containing documentation Markdown files.
+        nav_file: Path to the docforge.nav.yml specification.
+        template: Optional path to an mkdocs.yml template (overrides built-in).
+        out: Path where the final mkdocs.yml will be written.
+        site_name: The display name for the documentation site.
     """
     if not nav_file.exists():
         raise click.FileError(str(nav_file), hint="Nav spec not found")
@@ -49,6 +61,9 @@ def generate_config(docs_dir: Path, nav_file: Path, template: Path | None, out:
 def build(mkdocs_yml: Path) -> None:
     """
     Build the documentation site using MkDocs.
+
+    Args:
+        mkdocs_yml: Path to the mkdocs.yml configuration file.
     """
     if not mkdocs_yml.exists():
         raise click.ClickException(f"mkdocs.yml not found: {mkdocs_yml}")
@@ -61,6 +76,9 @@ def build(mkdocs_yml: Path) -> None:
 def serve(mkdocs_yml: Path) -> None:
     """
     Serve the documentation site with live-reload using MkDocs.
+
+    Args:
+        mkdocs_yml: Path to the mkdocs.yml configuration file.
     """
     if not mkdocs_yml.exists():
         raise click.ClickException(f"mkdocs.yml not found: {mkdocs_yml}")