{
  "module": "docforge.nav.spec",
  "content": {
    "path": "docforge.nav.spec",
    "docstring": "Navigation specification model.\n\nThis module defines the ``NavSpec`` class, which represents the navigation\nstructure defined by the user in the doc-forge navigation specification\n(typically ``docforge.nav.yml``).\n\n---\n\nNotes:\n    - The spec file supports an optional ``icon`` mapping for MkDocs theme\n      customization.\n    - All file references in ``groups`` are relative to the documentation root.\n\n---",
    "objects": {
      "annotations": {
        "name": "annotations",
        "kind": "alias",
        "path": "docforge.nav.spec.annotations",
        "signature": "<bound method Alias.signature of Alias('annotations', '__future__.annotations')>",
        "docstring": null
      },
      "Path": {
        "name": "Path",
        "kind": "alias",
        "path": "docforge.nav.spec.Path",
        "signature": "<bound method Alias.signature of Alias('Path', 'pathlib.Path')>",
        "docstring": null
      },
      "yaml": {
        "name": "yaml",
        "kind": "alias",
        "path": "docforge.nav.spec.yaml",
        "signature": "<bound method Alias.signature of Alias('yaml', 'yaml')>",
        "docstring": null
      },
      "NavSpec": {
        "name": "NavSpec",
        "kind": "class",
        "path": "docforge.nav.spec.NavSpec",
        "signature": "<bound method Class.signature of Class('NavSpec', 25, 136)>",
        "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.\n    icon: Optional mapping of theme icon entries (for example\n        ``{\"logo\": \"material/code-tags\"}``) injected into the MkDocs\n        theme as ``theme.icon``.",
        "members": {
          "home": {
            "name": "home",
            "kind": "attribute",
            "path": "docforge.nav.spec.NavSpec.home",
            "signature": null,
            "docstring": null
          },
          "groups": {
            "name": "groups",
            "kind": "attribute",
            "path": "docforge.nav.spec.NavSpec.groups",
            "signature": null,
            "docstring": null
          },
          "icon": {
            "name": "icon",
            "kind": "attribute",
            "path": "docforge.nav.spec.NavSpec.icon",
            "signature": null,
            "docstring": null
          },
          "load": {
            "name": "load",
            "kind": "function",
            "path": "docforge.nav.spec.NavSpec.load",
            "signature": "<bound method Function.signature of Function('load', 65, 117)>",
            "docstring": "Load a navigation specification from a YAML file.\n\nArgs:\n    path (Path):\n        Filesystem path to the navigation specification file.\n\nReturns:\n    NavSpec:\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.spec.NavSpec.all_patterns",
            "signature": "<bound method Function.signature of Function('all_patterns', 119, 136)>",
            "docstring": "Return all path patterns referenced by the specification.\n\nReturns:\n    list[str]:\n        A list containing the home document (if defined) and all\n        group pattern entries."
          }
        }
      },
      "load_nav_spec": {
        "name": "load_nav_spec",
        "kind": "function",
        "path": "docforge.nav.spec.load_nav_spec",
        "signature": "<bound method Function.signature of Function('load_nav_spec', 139, 170)>",
        "docstring": "Load a navigation specification file.\n\nThis helper function reads a YAML navigation file and constructs a\ncorresponding ``NavSpec`` instance.\n\nArgs:\n    path (Path):\n        Path to the navigation specification file.\n\nReturns:\n    NavSpec:\n        A ``NavSpec`` instance representing the parsed specification.\n\nRaises:\n    FileNotFoundError: If the specification file does not exist.\n    ValueError: If the YAML structure is invalid."
      }
    }
  }
}