standardize packaging, tooling, docs, CI, and licensing

docforge/cli/commands.py

@@ -6,12 +6,12 @@ Command definitions for the doc-forge CLI.
 Provides the CLI structure using Click, including build, serve, and tree commands.
 """
 
-import click
 from pathlib import Path
-from typing import Sequence, Optional
+
+import click
+
+from docforge.cli import mcp_utils, mkdocs_utils
 from docforge.loaders import GriffeLoader
-from docforge.cli import mkdocs_utils
-from docforge.cli import mcp_utils
 
 
 @click.group()
@@ -28,26 +28,52 @@ def cli() -> None:
 @cli.command()
 @click.option("--mcp", is_flag=True, help="Build MCP resources")
 @click.option("--mkdocs", is_flag=True, help="Build MkDocs site")
-@click.option("--module-is-source", is_flag=True, help="Module is source folder and to be treated as root folder")
+@click.option(
+    "--module-is-source",
+    is_flag=True,
+    help="Module is source folder and to be treated as root folder",
+)
 @click.option("--module", help="Python module to document")
 @click.option("--project-name", help="Project name override")
 @click.option("--site-name", help="MkDocs site name")
-@click.option("--docs-dir", type=click.Path(path_type=Path), default=Path("docs"), help="Directory for MD sources")
-@click.option("--nav", "nav_file", type=click.Path(path_type=Path), default=Path("docforge.nav.yml"),
-              help="Nav spec path")
-@click.option("--template", type=click.Path(path_type=Path), help="MkDocs template path")
-@click.option("--mkdocs-yml", type=click.Path(path_type=Path), default=Path("mkdocs.yml"), help="Output config path")
-@click.option("--out-dir", type=click.Path(path_type=Path), default=Path("mcp_docs"), help="MCP output directory")
+@click.option(
+    "--docs-dir",
+    type=click.Path(path_type=Path),
+    default=Path("docs"),
+    help="Directory for MD sources",
+)
+@click.option(
+    "--nav",
+    "nav_file",
+    type=click.Path(path_type=Path),
+    default=Path("docforge.nav.yml"),
+    help="Nav spec path",
+)
+@click.option(
+    "--template", type=click.Path(path_type=Path), help="MkDocs template path"
+)
+@click.option(
+    "--mkdocs-yml",
+    type=click.Path(path_type=Path),
+    default=Path("mkdocs.yml"),
+    help="Output config path",
+)
+@click.option(
+    "--out-dir",
+    type=click.Path(path_type=Path),
+    default=Path("mcp_docs"),
+    help="MCP output directory",
+)
 def build(
     mcp: bool,
     mkdocs: bool,
     module_is_source: bool,
-    module: Optional[str],
-    project_name: Optional[str],
-    site_name: Optional[str],
+    module: str | None,
+    project_name: str | None,
+    site_name: str | None,
     docs_dir: Path,
     nav_file: Path,
-    template: Optional[Path],
+    template: Path | None,
     mkdocs_yml: Path,
     out_dir: Path,
 ) -> None:
@@ -121,7 +147,9 @@ def build(
         )
 
         click.echo(f"Generating MkDocs config {mkdocs_yml}...")
-        mkdocs_utils.generate_config(docs_dir, nav_file, template, mkdocs_yml, site_name)
+        mkdocs_utils.generate_config(
+            docs_dir, nav_file, template, mkdocs_yml, site_name
+        )
 
         click.echo("Running MkDocs build...")
         mkdocs_utils.build(mkdocs_yml)
@@ -140,12 +168,22 @@ def build(
 @click.option("--mcp", is_flag=True, help="Serve MCP documentation")
 @click.option("--mkdocs", is_flag=True, help="Serve MkDocs site")
 @click.option("--module", help="Python module to serve")
-@click.option("--mkdocs-yml", type=click.Path(path_type=Path), default=Path("mkdocs.yml"), help="MkDocs config path")
-@click.option("--out-dir", type=click.Path(path_type=Path), default=Path("mcp_docs"), help="MCP root directory")
+@click.option(
+    "--mkdocs-yml",
+    type=click.Path(path_type=Path),
+    default=Path("mkdocs.yml"),
+    help="MkDocs config path",
+)
+@click.option(
+    "--out-dir",
+    type=click.Path(path_type=Path),
+    default=Path("mcp_docs"),
+    help="MCP root directory",
+)
 def serve(
     mcp: bool,
     mkdocs: bool,
-    module: Optional[str],
+    module: str | None,
     mkdocs_yml: Path,
     out_dir: Path,
 ) -> None:
@@ -202,7 +240,7 @@ def serve(
 )
 def tree(
     module: str,
-    project_name: Optional[str],
+    project_name: str | None,
 ) -> None:
     """
     Display the documentation object tree for a module.