module is source flag to ensure for single source modules it's not treated as a module but root

docforge/cli/commands.py

@@ -18,6 +18,7 @@ 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", help="Python module to document")
 @click.option("--project-name", help="Project name override")
 # MkDocs specific
@@ -32,6 +33,7 @@ def cli() -> None:
 def build(
     mcp: bool,
     mkdocs: bool,
+    module_is_source: bool,
     module: Optional[str],
     project_name: Optional[str],
     site_name: Optional[str],
@@ -52,7 +54,8 @@ def build(
     Args:
         mcp: Use the MCP documentation builder.
         mkdocs: Use the MkDocs documentation builder.
-        module: The dotted path of the module to document.
+        module_is_source: Module is the source folder and to be treated as the root folder.
+        module: The dotted path of the module to the document.
         project_name: Optional override for the project name.
         site_name: (MkDocs) The site display name. Defaults to module name.
         docs_dir: (MkDocs) Target directory for Markdown sources.
@@ -71,7 +74,12 @@ def build(
             site_name = module
 
         click.echo(f"Generating MkDocs sources in {docs_dir}...")
-        mkdocs_utils.generate_sources(module, project_name, docs_dir)
+        mkdocs_utils.generate_sources(
+            module,
+            docs_dir,
+            project_name,
+            module_is_source,
+        )
 
         click.echo(f"Generating MkDocs config {mkdocs_yml}...")
         mkdocs_utils.generate_config(docs_dir, nav_file, template, mkdocs_yml, site_name)

docforge/cli/commands.pyi

@@ -7,6 +7,7 @@ cli: Group
 def build(
     mcp: bool,
     mkdocs: bool,
+    module_is_source: bool,
     module: Optional[str],
     project_name: Optional[str],
     site_name: Optional[str],

docforge/cli/mkdocs_utils.py

@@ -6,7 +6,12 @@ from docforge.loaders import GriffeLoader, discover_module_paths
 from docforge.renderers import MkDocsRenderer
 from docforge.nav import load_nav_spec, resolve_nav, MkDocsNavEmitter
 
-def generate_sources(module: str, project_name: str | None, docs_dir: Path) -> None:
+def generate_sources(
+    module: str,
+    docs_dir: Path,
+    project_name: str | None = None,
+    module_is_source: bool | None = None,
+) -> None:
     """
     Generate Markdown source files for the specified module.
 
@@ -14,13 +19,18 @@ def generate_sources(module: str, project_name: str | None, docs_dir: Path) -> N
         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.
+        module_is_source: Module is the source folder and to be treated as the root folder.
     """
     loader = GriffeLoader()
     discovered_paths = discover_module_paths(module)
     project = loader.load_project(discovered_paths, project_name)
 
     renderer = MkDocsRenderer()
-    renderer.generate_sources(project, docs_dir)
+    renderer.generate_sources(
+        project,
+        docs_dir,
+        module_is_source,
+    )
 
 def generate_config(docs_dir: Path, nav_file: Path, template: Path | None, out: Path, site_name: str) -> None:
     """

docforge/cli/mkdocs_utils.pyi

@@ -1,6 +1,11 @@
 from pathlib import Path
 
-def generate_sources(module: str, project_name: str | None, docs_dir: Path) -> None: ...
+def generate_sources(
+    module: str,
+    docs_dir: Path,
+    project_name: str | None = None,
+    module_is_source: bool | None = None,
+) -> None: ...
 def generate_config(docs_dir: Path, nav_file: Path, template: Path | None, out: Path, site_name: str) -> None: ...
 def build(mkdocs_yml: Path) -> None: ...
 def serve(mkdocs_yml: Path) -> None: ...