doc-forge/mcp_docs/modules/docforge.nav.resolver.json

{
  "module": "docforge.nav.resolver",
  "content": {
    "path": "docforge.nav.resolver",
    "docstring": "This module contains the logic for resolving a NavSpec against the physical\nfilesystem. It expands globs and validates that all referenced documents\nactually exist on disk.",
    "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 the docforge navigation specification file.\n\nAttributes:\n    home: Path to the home document (e.g., 'index.md').\n    groups: Mapping of group titles to lists of path patterns/globs.",
        "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 NavSpec from a YAML file.\n\nArgs:\n    path: The filesystem path to the YAML file.\n\nReturns:\n    A NavSpec instance.\n\nRaises:\n    FileNotFoundError: If the path does not exist.\n    ValueError: If the file content is not a valid NavSpec mapping."
          },
          "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": "Get all path patterns referenced in the specification.\n\nReturns:\n    A list of all patterns (home plus all groups)."
          }
        }
      },
      "ResolvedNav": {
        "name": "ResolvedNav",
        "kind": "class",
        "path": "docforge.nav.resolver.ResolvedNav",
        "signature": "<bound method Class.signature of Class('ResolvedNav', 15, 56)>",
        "docstring": "Represents a navigation structure where all patterns and paths have been\nresolved against the actual filesystem contents.\n\nAttributes:\n    home: Resolved relative path to the home page.\n    groups: Mapping of group titles to lists of absolute or relative Path objects.",
        "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', 43, 56)>",
            "docstring": "Get an iterable of all resolved files in the navigation structure.\n\nReturns:\n    An iterable of Path objects."
          }
        }
      },
      "resolve_nav": {
        "name": "resolve_nav",
        "kind": "function",
        "path": "docforge.nav.resolver.resolve_nav",
        "signature": "<bound method Function.signature of Function('resolve_nav', 59, 124)>",
        "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."
      },
      "Optional": {
        "name": "Optional",
        "kind": "alias",
        "path": "docforge.nav.resolver.Optional",
        "signature": "<bound method Alias.signature of Alias('Optional', 'typing.Optional')>",
        "docstring": null
      }
    }
  }
}