{
  "module": "docforge.nav.mkdocs",
  "content": {
    "path": "docforge.nav.mkdocs",
    "docstring": "MkDocs navigation emitter.\n\nThis module provides the ``MkDocsNavEmitter`` class, which converts a\n``ResolvedNav`` instance into the navigation structure required by the\nMkDocs ``nav`` configuration.\n\n---\n\nNotes:\n    - The emitted structure is a list of dictionaries, one per top-level nav\n      entry, matching the MkDocs ``nav`` YAML format.\n\n---",
    "objects": {
      "ResolvedNav": {
        "name": "ResolvedNav",
        "kind": "class",
        "path": "docforge.nav.mkdocs.ResolvedNav",
        "signature": "ResolvedNav(home: str | None, groups: dict[str, list[Path]], docs_root: Path | None = None)",
        "docstring": "Resolved navigation structure.\n\nA ``ResolvedNav`` represents navigation data after glob patterns have been\nexpanded and paths validated against the filesystem.\n\nAttributes:\n    home: Relative path to the documentation home page.\n    groups: Mapping of navigation group titles to lists of resolved\n        documentation file paths.",
        "members": {
          "home": {
            "name": "home",
            "kind": "attribute",
            "path": "docforge.nav.mkdocs.ResolvedNav.home",
            "signature": null,
            "docstring": null
          },
          "groups": {
            "name": "groups",
            "kind": "attribute",
            "path": "docforge.nav.mkdocs.ResolvedNav.groups",
            "signature": null,
            "docstring": null
          },
          "all_files": {
            "name": "all_files",
            "kind": "function",
            "path": "docforge.nav.mkdocs.ResolvedNav.all_files",
            "signature": "all_files()",
            "docstring": "Iterate over all files referenced by the navigation structure.\n\nYields:\n    Path:\n        A documentation file referenced by the navigation, including\n        the home page when defined.\n\nRaises:\n    RuntimeError: If the home page is defined but the documentation\n        root is not available for resolution."
          }
        }
      },
      "MkDocsNavEmitter": {
        "name": "MkDocsNavEmitter",
        "kind": "class",
        "path": "docforge.nav.mkdocs.MkDocsNavEmitter",
        "signature": null,
        "docstring": "Emit MkDocs navigation structures from resolved navigation data.\n\nThe emitter transforms a ``ResolvedNav`` object into the YAML-compatible\nlist structure expected by the MkDocs ``nav`` configuration field.",
        "members": {
          "emit": {
            "name": "emit",
            "kind": "function",
            "path": "docforge.nav.mkdocs.MkDocsNavEmitter.emit",
            "signature": "emit(nav: ResolvedNav) -> list[dict[str, Any]]",
            "docstring": "Generate a navigation structure for ``mkdocs.yml``.\n\nArgs:\n    nav (ResolvedNav):\n        Resolved navigation data describing documentation groups\n        and their associated Markdown files.\n\nReturns:\n    list[dict[str, Any]]:\n        A list of dictionaries representing the MkDocs navigation layout.\n        Each dictionary maps a navigation label to a page or a list of\n        pages."
          }
        }
      }
    }
  }
}