{
  "module": "docforge.cli.commands",
  "content": {
    "path": "docforge.cli.commands",
    "docstring": null,
    "objects": {
      "click": {
        "name": "click",
        "kind": "alias",
        "path": "docforge.cli.commands.click",
        "signature": "<bound method Alias.signature of Alias('click', 'click')>",
        "docstring": null
      },
      "Path": {
        "name": "Path",
        "kind": "alias",
        "path": "docforge.cli.commands.Path",
        "signature": "<bound method Alias.signature of Alias('Path', 'pathlib.Path')>",
        "docstring": null
      },
      "Sequence": {
        "name": "Sequence",
        "kind": "alias",
        "path": "docforge.cli.commands.Sequence",
        "signature": "<bound method Alias.signature of Alias('Sequence', 'typing.Sequence')>",
        "docstring": null
      },
      "Optional": {
        "name": "Optional",
        "kind": "alias",
        "path": "docforge.cli.commands.Optional",
        "signature": "<bound method Alias.signature of Alias('Optional', 'typing.Optional')>",
        "docstring": null
      },
      "GriffeLoader": {
        "name": "GriffeLoader",
        "kind": "class",
        "path": "docforge.cli.commands.GriffeLoader",
        "signature": "<bound method Alias.signature of Alias('GriffeLoader', 'docforge.loaders.GriffeLoader')>",
        "docstring": "Loads Python modules and extracts documentation using the Griffe introspection engine.",
        "members": {
          "load_project": {
            "name": "load_project",
            "kind": "function",
            "path": "docforge.cli.commands.GriffeLoader.load_project",
            "signature": "<bound method Alias.signature of Alias('load_project', 'docforge.loaders.griffe_loader.GriffeLoader.load_project')>",
            "docstring": "Load multiple modules and combine them into a single Project models.\n\nArgs:\n    module_paths: A list of dotted paths to the modules to load.\n    project_name: Optional name for the project. Defaults to the first module name.\n    skip_import_errors: If True, modules that fail to import will be skipped.\n\nReturns:\n    A Project instance containing the loaded modules."
          },
          "load_module": {
            "name": "load_module",
            "kind": "function",
            "path": "docforge.cli.commands.GriffeLoader.load_module",
            "signature": "<bound method Alias.signature of Alias('load_module', 'docforge.loaders.griffe_loader.GriffeLoader.load_module')>",
            "docstring": "Load a single module and convert its introspection data into the docforge models.\n\nArgs:\n    path: The dotted path of the module to load.\n\nReturns:\n    A Module instance."
          }
        }
      },
      "mkdocs_utils": {
        "name": "mkdocs_utils",
        "kind": "module",
        "path": "docforge.cli.commands.mkdocs_utils",
        "signature": "<bound method Alias.signature of Alias('mkdocs_utils', 'docforge.cli.mkdocs_utils')>",
        "docstring": null,
        "members": {
          "Path": {
            "name": "Path",
            "kind": "alias",
            "path": "docforge.cli.commands.mkdocs_utils.Path",
            "signature": "<bound method Alias.signature of Alias('Path', 'docforge.cli.mkdocs_utils.Path')>",
            "docstring": null
          },
          "resources": {
            "name": "resources",
            "kind": "alias",
            "path": "docforge.cli.commands.mkdocs_utils.resources",
            "signature": "<bound method Alias.signature of Alias('resources', 'docforge.cli.mkdocs_utils.resources')>",
            "docstring": null
          },
          "click": {
            "name": "click",
            "kind": "alias",
            "path": "docforge.cli.commands.mkdocs_utils.click",
            "signature": "<bound method Alias.signature of Alias('click', 'docforge.cli.mkdocs_utils.click')>",
            "docstring": null
          },
          "yaml": {
            "name": "yaml",
            "kind": "alias",
            "path": "docforge.cli.commands.mkdocs_utils.yaml",
            "signature": "<bound method Alias.signature of Alias('yaml', 'docforge.cli.mkdocs_utils.yaml')>",
            "docstring": null
          },
          "GriffeLoader": {
            "name": "GriffeLoader",
            "kind": "class",
            "path": "docforge.cli.commands.mkdocs_utils.GriffeLoader",
            "signature": "<bound method Alias.signature of Alias('GriffeLoader', 'docforge.cli.mkdocs_utils.GriffeLoader')>",
            "docstring": "Loads Python modules and extracts documentation using the Griffe introspection engine.",
            "members": {
              "load_project": {
                "name": "load_project",
                "kind": "function",
                "path": "docforge.cli.commands.mkdocs_utils.GriffeLoader.load_project",
                "signature": "<bound method Alias.signature of Alias('load_project', 'docforge.loaders.griffe_loader.GriffeLoader.load_project')>",
                "docstring": "Load multiple modules and combine them into a single Project models.\n\nArgs:\n    module_paths: A list of dotted paths to the modules to load.\n    project_name: Optional name for the project. Defaults to the first module name.\n    skip_import_errors: If True, modules that fail to import will be skipped.\n\nReturns:\n    A Project instance containing the loaded modules."
              },
              "load_module": {
                "name": "load_module",
                "kind": "function",
                "path": "docforge.cli.commands.mkdocs_utils.GriffeLoader.load_module",
                "signature": "<bound method Alias.signature of Alias('load_module', 'docforge.loaders.griffe_loader.GriffeLoader.load_module')>",
                "docstring": "Load a single module and convert its introspection data into the docforge models.\n\nArgs:\n    path: The dotted path of the module to load.\n\nReturns:\n    A Module instance."
              }
            }
          },
          "discover_module_paths": {
            "name": "discover_module_paths",
            "kind": "function",
            "path": "docforge.cli.commands.mkdocs_utils.discover_module_paths",
            "signature": "<bound method Alias.signature of Alias('discover_module_paths', 'docforge.cli.mkdocs_utils.discover_module_paths')>",
            "docstring": "Discover all Python modules under a package via filesystem traversal.\n\nRules:\n- Directory with __init__.py is treated as a package.\n- Any .py file is treated as a module.\n- All paths are converted to dotted module paths.\n\nArgs:\n    module_name: The name of the package to discover.\n    project_root: The root directory of the project. Defaults to current working directory.\n\nReturns:\n    A sorted list of dotted module paths."
          },
          "MkDocsRenderer": {
            "name": "MkDocsRenderer",
            "kind": "class",
            "path": "docforge.cli.commands.mkdocs_utils.MkDocsRenderer",
            "signature": "<bound method Alias.signature of Alias('MkDocsRenderer', 'docforge.cli.mkdocs_utils.MkDocsRenderer')>",
            "docstring": "Renderer that generates Markdown source files formatted for the MkDocs\n'mkdocstrings' plugin.",
            "members": {
              "name": {
                "name": "name",
                "kind": "attribute",
                "path": "docforge.cli.commands.mkdocs_utils.MkDocsRenderer.name",
                "signature": "<bound method Alias.signature of Alias('name', 'docforge.renderers.mkdocs_renderer.MkDocsRenderer.name')>",
                "docstring": null
              },
              "generate_sources": {
                "name": "generate_sources",
                "kind": "function",
                "path": "docforge.cli.commands.mkdocs_utils.MkDocsRenderer.generate_sources",
                "signature": "<bound method Alias.signature of Alias('generate_sources', 'docforge.renderers.mkdocs_renderer.MkDocsRenderer.generate_sources')>",
                "docstring": "Produce a set of Markdown files in the output directory based on the\nprovided Project models.\n\nArgs:\n    project: The project models to render.\n    out_dir: Target directory for documentation files."
              }
            }
          },
          "load_nav_spec": {
            "name": "load_nav_spec",
            "kind": "function",
            "path": "docforge.cli.commands.mkdocs_utils.load_nav_spec",
            "signature": "<bound method Alias.signature of Alias('load_nav_spec', 'docforge.cli.mkdocs_utils.load_nav_spec')>",
            "docstring": "Utility function to load a NavSpec from a file.\n\nArgs:\n    path: Path to the navigation specification file.\n\nReturns:\n    A loaded NavSpec instance."
          },
          "resolve_nav": {
            "name": "resolve_nav",
            "kind": "function",
            "path": "docforge.cli.commands.mkdocs_utils.resolve_nav",
            "signature": "<bound method Alias.signature of Alias('resolve_nav', 'docforge.cli.mkdocs_utils.resolve_nav')>",
            "docstring": "Create a ResolvedNav by processing a NavSpec against the filesystem.\nThis expands globs and validates the existence of referenced files.\n\nArgs:\n    spec: The navigation specification to resolve.\n    docs_root: The root directory for documentation files.\n\nReturns:\n    A ResolvedNav instance.\n\nRaises:\n    FileNotFoundError: If a pattern doesn't match any files or the docs_root doesn't exist."
          },
          "MkDocsNavEmitter": {
            "name": "MkDocsNavEmitter",
            "kind": "class",
            "path": "docforge.cli.commands.mkdocs_utils.MkDocsNavEmitter",
            "signature": "<bound method Alias.signature of Alias('MkDocsNavEmitter', 'docforge.cli.mkdocs_utils.MkDocsNavEmitter')>",
            "docstring": "Emitter responsible for transforming a ResolvedNav into an MkDocs-compatible\nnavigation structure.",
            "members": {
              "emit": {
                "name": "emit",
                "kind": "function",
                "path": "docforge.cli.commands.mkdocs_utils.MkDocsNavEmitter.emit",
                "signature": "<bound method Alias.signature of Alias('emit', 'docforge.nav.mkdocs.MkDocsNavEmitter.emit')>",
                "docstring": "Generate a list of navigation entries for mkdocs.yml.\n\nArgs:\n    nav: The resolved navigation data.\n\nReturns:\n    A list of dictionary mappings representing the MkDocs navigation."
              }
            }
          },
          "generate_sources": {
            "name": "generate_sources",
            "kind": "function",
            "path": "docforge.cli.commands.mkdocs_utils.generate_sources",
            "signature": "<bound method Alias.signature of Alias('generate_sources', 'docforge.cli.mkdocs_utils.generate_sources')>",
            "docstring": "Generate Markdown source files for the specified module.\n\nArgs:\n    module: The dotted path of the primary module to document.\n    project_name: Optional override for the project name.\n    docs_dir: Directory where the generated Markdown files will be written."
          },
          "generate_config": {
            "name": "generate_config",
            "kind": "function",
            "path": "docforge.cli.commands.mkdocs_utils.generate_config",
            "signature": "<bound method Alias.signature of Alias('generate_config', 'docforge.cli.mkdocs_utils.generate_config')>",
            "docstring": "Generate an mkdocs.yml configuration file.\n\nArgs:\n    docs_dir: Path to the directory containing documentation Markdown files.\n    nav_file: Path to the docforge.nav.yml specification.\n    template: Optional path to an mkdocs.yml template (overrides built-in).\n    out: Path where the final mkdocs.yml will be written.\n    site_name: The display name for the documentation site."
          },
          "build": {
            "name": "build",
            "kind": "function",
            "path": "docforge.cli.commands.mkdocs_utils.build",
            "signature": "<bound method Alias.signature of Alias('build', 'docforge.cli.mkdocs_utils.build')>",
            "docstring": "Build the documentation site using MkDocs.\n\nArgs:\n    mkdocs_yml: Path to the mkdocs.yml configuration file."
          },
          "serve": {
            "name": "serve",
            "kind": "function",
            "path": "docforge.cli.commands.mkdocs_utils.serve",
            "signature": "<bound method Alias.signature of Alias('serve', 'docforge.cli.mkdocs_utils.serve')>",
            "docstring": "Serve the documentation site with live-reload using MkDocs.\n\nArgs:\n    mkdocs_yml: Path to the mkdocs.yml configuration file."
          }
        }
      },
      "mcp_utils": {
        "name": "mcp_utils",
        "kind": "module",
        "path": "docforge.cli.commands.mcp_utils",
        "signature": "<bound method Alias.signature of Alias('mcp_utils', 'docforge.cli.mcp_utils')>",
        "docstring": null,
        "members": {
          "Path": {
            "name": "Path",
            "kind": "alias",
            "path": "docforge.cli.commands.mcp_utils.Path",
            "signature": "<bound method Alias.signature of Alias('Path', 'docforge.cli.mcp_utils.Path')>",
            "docstring": null
          },
          "click": {
            "name": "click",
            "kind": "alias",
            "path": "docforge.cli.commands.mcp_utils.click",
            "signature": "<bound method Alias.signature of Alias('click', 'docforge.cli.mcp_utils.click')>",
            "docstring": null
          },
          "GriffeLoader": {
            "name": "GriffeLoader",
            "kind": "class",
            "path": "docforge.cli.commands.mcp_utils.GriffeLoader",
            "signature": "<bound method Alias.signature of Alias('GriffeLoader', 'docforge.cli.mcp_utils.GriffeLoader')>",
            "docstring": "Loads Python modules and extracts documentation using the Griffe introspection engine.",
            "members": {
              "load_project": {
                "name": "load_project",
                "kind": "function",
                "path": "docforge.cli.commands.mcp_utils.GriffeLoader.load_project",
                "signature": "<bound method Alias.signature of Alias('load_project', 'docforge.loaders.griffe_loader.GriffeLoader.load_project')>",
                "docstring": "Load multiple modules and combine them into a single Project models.\n\nArgs:\n    module_paths: A list of dotted paths to the modules to load.\n    project_name: Optional name for the project. Defaults to the first module name.\n    skip_import_errors: If True, modules that fail to import will be skipped.\n\nReturns:\n    A Project instance containing the loaded modules."
              },
              "load_module": {
                "name": "load_module",
                "kind": "function",
                "path": "docforge.cli.commands.mcp_utils.GriffeLoader.load_module",
                "signature": "<bound method Alias.signature of Alias('load_module', 'docforge.loaders.griffe_loader.GriffeLoader.load_module')>",
                "docstring": "Load a single module and convert its introspection data into the docforge models.\n\nArgs:\n    path: The dotted path of the module to load.\n\nReturns:\n    A Module instance."
              }
            }
          },
          "discover_module_paths": {
            "name": "discover_module_paths",
            "kind": "function",
            "path": "docforge.cli.commands.mcp_utils.discover_module_paths",
            "signature": "<bound method Alias.signature of Alias('discover_module_paths', 'docforge.cli.mcp_utils.discover_module_paths')>",
            "docstring": "Discover all Python modules under a package via filesystem traversal.\n\nRules:\n- Directory with __init__.py is treated as a package.\n- Any .py file is treated as a module.\n- All paths are converted to dotted module paths.\n\nArgs:\n    module_name: The name of the package to discover.\n    project_root: The root directory of the project. Defaults to current working directory.\n\nReturns:\n    A sorted list of dotted module paths."
          },
          "MCPRenderer": {
            "name": "MCPRenderer",
            "kind": "class",
            "path": "docforge.cli.commands.mcp_utils.MCPRenderer",
            "signature": "<bound method Alias.signature of Alias('MCPRenderer', 'docforge.cli.mcp_utils.MCPRenderer')>",
            "docstring": "Renderer that emits MCP-native JSON resources from docforge models.",
            "members": {
              "name": {
                "name": "name",
                "kind": "attribute",
                "path": "docforge.cli.commands.mcp_utils.MCPRenderer.name",
                "signature": "<bound method Alias.signature of Alias('name', 'docforge.renderers.mcp_renderer.MCPRenderer.name')>",
                "docstring": null
              },
              "generate_sources": {
                "name": "generate_sources",
                "kind": "function",
                "path": "docforge.cli.commands.mcp_utils.MCPRenderer.generate_sources",
                "signature": "<bound method Alias.signature of Alias('generate_sources', 'docforge.renderers.mcp_renderer.MCPRenderer.generate_sources')>",
                "docstring": "Generate MCP-compatible JSON resources and navigation for the project.\n\nArgs:\n    project: The project model to render.\n    out_dir: Target directory for the generated JSON files."
              }
            }
          },
          "MCPServer": {
            "name": "MCPServer",
            "kind": "class",
            "path": "docforge.cli.commands.mcp_utils.MCPServer",
            "signature": "<bound method Alias.signature of Alias('MCPServer', 'docforge.cli.mcp_utils.MCPServer')>",
            "docstring": "MCP server for serving a pre-built MCP documentation bundle.",
            "members": {
              "mcp_root": {
                "name": "mcp_root",
                "kind": "attribute",
                "path": "docforge.cli.commands.mcp_utils.MCPServer.mcp_root",
                "signature": "<bound method Alias.signature of Alias('mcp_root', 'docforge.servers.mcp_server.MCPServer.mcp_root')>",
                "docstring": null
              },
              "app": {
                "name": "app",
                "kind": "attribute",
                "path": "docforge.cli.commands.mcp_utils.MCPServer.app",
                "signature": "<bound method Alias.signature of Alias('app', 'docforge.servers.mcp_server.MCPServer.app')>",
                "docstring": null
              },
              "run": {
                "name": "run",
                "kind": "function",
                "path": "docforge.cli.commands.mcp_utils.MCPServer.run",
                "signature": "<bound method Alias.signature of Alias('run', 'docforge.servers.mcp_server.MCPServer.run')>",
                "docstring": "Start the MCP server.\n\nArgs:\n    transport: MCP transport (default: streamable-http)"
              }
            }
          },
          "generate_resources": {
            "name": "generate_resources",
            "kind": "function",
            "path": "docforge.cli.commands.mcp_utils.generate_resources",
            "signature": "<bound method Alias.signature of Alias('generate_resources', 'docforge.cli.mcp_utils.generate_resources')>",
            "docstring": "Generate MCP-compatible documentation resources.\n\nArgs:\n    module: The dotted path of the primary module to document.\n    project_name: Optional override for the project name.\n    out_dir: Directory where the MCP JSON resources and nav will be written."
          },
          "serve": {
            "name": "serve",
            "kind": "function",
            "path": "docforge.cli.commands.mcp_utils.serve",
            "signature": "<bound method Alias.signature of Alias('serve', 'docforge.cli.mcp_utils.serve')>",
            "docstring": "Serve MCP documentation from a pre-built bundle.\n\nArgs:\n    mcp_root: Path to the directory containing index.json, nav.json, and modules/."
          }
        }
      },
      "cli": {
        "name": "cli",
        "kind": "attribute",
        "path": "docforge.cli.commands.cli",
        "signature": null,
        "docstring": null
      },
      "build": {
        "name": "build",
        "kind": "function",
        "path": "docforge.cli.commands.build",
        "signature": "<bound method Function.signature of Function('build', 18, 89)>",
        "docstring": "Build documentation (MkDocs site or MCP resources).\n\nThis command orchestrates the full build process:\n1. Introspects the code (Griffe)\n2. Renders sources (MkDocs Markdown or MCP JSON)\n3. (MkDocs only) Generates config and runs the final site build.\n\nArgs:\n    mcp: Use the MCP documentation builder.\n    mkdocs: Use the MkDocs documentation builder.\n    module: The dotted path of the module to document.\n    project_name: Optional override for the project name.\n    site_name: (MkDocs) The site display name. Defaults to module name.\n    docs_dir: (MkDocs) Target directory for Markdown sources.\n    nav_file: (MkDocs) Path to the docforge.nav.yml specification.\n    template: (MkDocs) Optional custom mkdocs.yml template.\n    mkdocs_yml: (MkDocs) Target path for the generated mkdocs.yml.\n    out_dir: (MCP) Target directory for MCP JSON resources."
      },
      "serve": {
        "name": "serve",
        "kind": "function",
        "path": "docforge.cli.commands.serve",
        "signature": "<bound method Function.signature of Function('serve', 92, 120)>",
        "docstring": "Serve documentation (MkDocs or MCP).\n\nArgs:\n    mcp: Serve MCP resources via an MCP server.\n    mkdocs: Serve the MkDocs site using the built-in development server.\n    mkdocs_yml: (MkDocs) Path to the mkdocs.yml configuration.\n    out_dir: (MCP) Path to the mcp_docs/ directory."
      },
      "tree": {
        "name": "tree",
        "kind": "function",
        "path": "docforge.cli.commands.tree",
        "signature": "<bound method Function.signature of Function('tree', 123, 153)>",
        "docstring": "Visualize the project structure in the terminal.\n\nArgs:\n    modules: List of module import paths to recursively introspect.\n    project_name: Optional override for the project name shown at the root."
      },
      "Group": {
        "name": "Group",
        "kind": "alias",
        "path": "docforge.cli.commands.Group",
        "signature": "<bound method Alias.signature of Alias('Group', 'click.core.Group')>",
        "docstring": null
      },
      "Any": {
        "name": "Any",
        "kind": "alias",
        "path": "docforge.cli.commands.Any",
        "signature": "<bound method Alias.signature of Alias('Any', 'typing.Any')>",
        "docstring": null
      }
    }
  }
}