Vishesh 'ironeagle' Bangotra
06ffd2febd
Squash-merge lib-standardisation: adopt repo standards across packaging, tooling, docs, and CI. - standardize pyproject.toml (canonical packaging, lint config, extras, GSDFC pydoclint) - add py.typed marker, modernize type hints and Google-style docstrings - nest generated docs under docs/lib and docs/mcp; add hand-written wiki - adopt standard Type A PyPI CI pipeline (tag==version guard + quality gate) - promote generated CHANGELOG.md; bump version to 0.0.7
49 lines
1.1 KiB
Python
49 lines
1.1 KiB
Python
from collections.abc import Iterable
|
||
from pathlib import Path
|
||
|
||
from docforge.nav.spec import NavSpec
|
||
|
||
class ResolvedNav:
|
||
"""
|
||
Fully-resolved navigation tree.
|
||
|
||
- `home` is a semantic, docs-root–relative path (string)
|
||
- `groups` contain resolved filesystem Paths
|
||
- Order is preserved
|
||
"""
|
||
|
||
home: str | None
|
||
groups: dict[str, list[Path]]
|
||
_docs_root: Path | None
|
||
|
||
def __init__(
|
||
self,
|
||
home: str | None,
|
||
groups: dict[str, list[Path]],
|
||
docs_root: Path | None = ...,
|
||
) -> None: ...
|
||
def all_files(self) -> Iterable[Path]:
|
||
"""
|
||
Return all resolved documentation files in nav order.
|
||
|
||
Includes the home file (resolved against docs_root)
|
||
followed by all group files.
|
||
"""
|
||
...
|
||
|
||
def resolve_nav(
|
||
spec: NavSpec,
|
||
docs_root: Path,
|
||
) -> ResolvedNav:
|
||
"""
|
||
Resolve a NavSpec against a docs directory.
|
||
|
||
Expands wildcards, validates existence, and
|
||
resolves filesystem paths relative to docs_root.
|
||
|
||
Raises:
|
||
FileNotFoundError: if any referenced file is missing
|
||
ValueError: if resolution fails
|
||
"""
|
||
...
|