{
  "module": "docforge.nav.resolver",
  "content": {
    "path": "docforge.nav.resolver",
    "docstring": "Navigation resolution utilities.\n\nThis module resolves a ``NavSpec`` against the filesystem by expanding glob\npatterns and validating that referenced documentation files exist.",
    "objects": {
      "Path": {
        "name": "Path",
        "kind": "alias",
        "path": "docforge.nav.resolver.Path",
        "signature": "<bound method Alias.signature of Alias('Path', 'pathlib.Path')>",
        "docstring": null
      },
      "Dict": {
        "name": "Dict",
        "kind": "alias",
        "path": "docforge.nav.resolver.Dict",
        "signature": "<bound method Alias.signature of Alias('Dict', 'typing.Dict')>",
        "docstring": null
      },
      "Iterable": {
        "name": "Iterable",
        "kind": "alias",
        "path": "docforge.nav.resolver.Iterable",
        "signature": "<bound method Alias.signature of Alias('Iterable', 'typing.Iterable')>",
        "docstring": null
      },
      "List": {
        "name": "List",
        "kind": "alias",
        "path": "docforge.nav.resolver.List",
        "signature": "<bound method Alias.signature of Alias('List', 'typing.List')>",
        "docstring": null
      },
      "glob": {
        "name": "glob",
        "kind": "alias",
        "path": "docforge.nav.resolver.glob",
        "signature": "<bound method Alias.signature of Alias('glob', 'glob')>",
        "docstring": null
      },
      "NavSpec": {
        "name": "NavSpec",
        "kind": "class",
        "path": "docforge.nav.resolver.NavSpec",
        "signature": "<bound method Alias.signature of Alias('NavSpec', 'docforge.nav.spec.NavSpec')>",
        "docstring": "Parsed representation of a navigation specification.\n\nA ``NavSpec`` describes the intended documentation navigation layout before\nit is resolved against the filesystem.\n\nAttributes:\n    home: Relative path to the documentation home page (for example\n        ``index.md``).\n    groups: Mapping of navigation group titles to lists of file patterns\n        or glob expressions.",
        "members": {
          "home": {
            "name": "home",
            "kind": "attribute",
            "path": "docforge.nav.resolver.NavSpec.home",
            "signature": "<bound method Alias.signature of Alias('home', 'docforge.nav.spec.NavSpec.home')>",
            "docstring": null
          },
          "groups": {
            "name": "groups",
            "kind": "attribute",
            "path": "docforge.nav.resolver.NavSpec.groups",
            "signature": "<bound method Alias.signature of Alias('groups', 'docforge.nav.spec.NavSpec.groups')>",
            "docstring": null
          },
          "load": {
            "name": "load",
            "kind": "function",
            "path": "docforge.nav.resolver.NavSpec.load",
            "signature": "<bound method Alias.signature of Alias('load', 'docforge.nav.spec.NavSpec.load')>",
            "docstring": "Load a navigation specification from a YAML file.\n\nArgs:\n    path: Filesystem path to the navigation specification file.\n\nReturns:\n    A ``NavSpec`` instance representing the parsed configuration.\n\nRaises:\n    FileNotFoundError: If the specified file does not exist.\n    ValueError: If the file contents are not a valid navigation\n        specification."
          },
          "all_patterns": {
            "name": "all_patterns",
            "kind": "function",
            "path": "docforge.nav.resolver.NavSpec.all_patterns",
            "signature": "<bound method Alias.signature of Alias('all_patterns', 'docforge.nav.spec.NavSpec.all_patterns')>",
            "docstring": "Return all path patterns referenced by the specification.\n\nReturns:\n    A list containing the home document (if defined) and all\n    group pattern entries."
          }
        }
      },
      "ResolvedNav": {
        "name": "ResolvedNav",
        "kind": "class",
        "path": "docforge.nav.resolver.ResolvedNav",
        "signature": "<bound method Class.signature of Class('ResolvedNav', 16, 65)>",
        "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.resolver.ResolvedNav.home",
            "signature": null,
            "docstring": null
          },
          "groups": {
            "name": "groups",
            "kind": "attribute",
            "path": "docforge.nav.resolver.ResolvedNav.groups",
            "signature": null,
            "docstring": null
          },
          "all_files": {
            "name": "all_files",
            "kind": "function",
            "path": "docforge.nav.resolver.ResolvedNav.all_files",
            "signature": "<bound method Function.signature of Function('all_files', 47, 65)>",
            "docstring": "Iterate over all files referenced by the navigation structure.\n\nReturns:\n    An iterable of ``Path`` objects representing documentation files.\n\nRaises:\n    RuntimeError: If the home page is defined but the documentation\n        root is not available for resolution."
          }
        }
      },
      "resolve_nav": {
        "name": "resolve_nav",
        "kind": "function",
        "path": "docforge.nav.resolver.resolve_nav",
        "signature": "<bound method Function.signature of Function('resolve_nav', 68, 136)>",
        "docstring": "Resolve a navigation specification against the filesystem.\n\nThe function expands glob patterns defined in a ``NavSpec`` and verifies\nthat referenced documentation files exist within the documentation root.\n\nArgs:\n    spec: Navigation specification describing documentation layout.\n    docs_root: Root directory containing documentation Markdown files.\n\nReturns:\n    A ``ResolvedNav`` instance containing validated navigation paths.\n\nRaises:\n    FileNotFoundError: If the documentation root does not exist or a\n        navigation pattern does not match any files."
      },
      "Optional": {
        "name": "Optional",
        "kind": "alias",
        "path": "docforge.nav.resolver.Optional",
        "signature": "<bound method Alias.signature of Alias('Optional', 'typing.Optional')>",
        "docstring": null
      }
    }
  }
}