{
  "module": "docforge.cli.mkdocs",
  "content": {
    "path": "docforge.cli.mkdocs",
    "docstring": "This module contains the 'mkdocs' CLI command, which orchestrates the generation\nof the main mkdocs.yml configuration file.",
    "objects": {
      "Path": {
        "name": "Path",
        "kind": "alias",
        "path": "docforge.cli.mkdocs.Path",
        "signature": "<bound method Alias.signature of Alias('Path', 'pathlib.Path')>",
        "docstring": null
      },
      "resources": {
        "name": "resources",
        "kind": "alias",
        "path": "docforge.cli.mkdocs.resources",
        "signature": "<bound method Alias.signature of Alias('resources', 'importlib.resources')>",
        "docstring": null
      },
      "click": {
        "name": "click",
        "kind": "alias",
        "path": "docforge.cli.mkdocs.click",
        "signature": "<bound method Alias.signature of Alias('click', 'click')>",
        "docstring": null
      },
      "yaml": {
        "name": "yaml",
        "kind": "alias",
        "path": "docforge.cli.mkdocs.yaml",
        "signature": "<bound method Alias.signature of Alias('yaml', 'yaml')>",
        "docstring": null
      },
      "load_nav_spec": {
        "name": "load_nav_spec",
        "kind": "function",
        "path": "docforge.cli.mkdocs.load_nav_spec",
        "signature": "<bound method Alias.signature of Alias('load_nav_spec', 'docforge.nav.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.mkdocs.resolve_nav",
        "signature": "<bound method Alias.signature of Alias('resolve_nav', 'docforge.nav.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.mkdocs.MkDocsNavEmitter",
        "signature": "<bound method Alias.signature of Alias('MkDocsNavEmitter', 'docforge.nav.MkDocsNavEmitter')>",
        "docstring": "Emitter responsible for transforming a ResolvedNav into an MkDocs-compatible\nnavigation structure.",
        "members": {
          "emit": {
            "name": "emit",
            "kind": "function",
            "path": "docforge.cli.mkdocs.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."
          }
        }
      },
      "mkdocs_cmd": {
        "name": "mkdocs_cmd",
        "kind": "function",
        "path": "docforge.cli.mkdocs.mkdocs_cmd",
        "signature": "<bound method Function.signature of Function('mkdocs_cmd', 42, 116)>",
        "docstring": "Generate an mkdocs.yml configuration file by combining a template with\nthe navigation structure resolved from a docforge.nav.yml 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.\n    out: Path where the final mkdocs.yml will be written.\n    site_name: The name of the documentation site."
      },
      "Any": {
        "name": "Any",
        "kind": "alias",
        "path": "docforge.cli.mkdocs.Any",
        "signature": "<bound method Alias.signature of Alias('Any', 'typing.Any')>",
        "docstring": null
      },
      "Dict": {
        "name": "Dict",
        "kind": "alias",
        "path": "docforge.cli.mkdocs.Dict",
        "signature": "<bound method Alias.signature of Alias('Dict', 'typing.Dict')>",
        "docstring": null
      },
      "Optional": {
        "name": "Optional",
        "kind": "alias",
        "path": "docforge.cli.mkdocs.Optional",
        "signature": "<bound method Alias.signature of Alias('Optional', 'typing.Optional')>",
        "docstring": null
      }
    }
  }
}