httk.core.docs.ecosystem

Discover and validate the module pins used by the aggregate documentation site.

Exceptions

EcosystemManifestError

Raised when an ecosystem checkout cannot produce a valid manifest.

Functions

build_ecosystem_manifest(→ dict[str, object])	Build the sorted manifest for direct Git checkouts under submodules_dir.
read_ecosystem_manifest(→ dict[str, object])	Read a JSON manifest and report malformed files as typed errors.
write_ecosystem_manifest(→ None)	Write manifest as sorted, newline-terminated JSON using an atomic replace.
verify_ecosystem_manifest(→ None)	Verify a committed manifest against the current checkout state.

Module Contents

exception httk.core.docs.ecosystem.EcosystemManifestError

Bases: RuntimeError

Raised when an ecosystem checkout cannot produce a valid manifest.

httk.core.docs.ecosystem.build_ecosystem_manifest(submodules_dir: str | pathlib.Path, *, require_release_tags: bool = False) → dict[str, object]

Build the sorted manifest for direct Git checkouts under submodules_dir.

httk.core.docs.ecosystem.read_ecosystem_manifest(path: str | pathlib.Path) → dict[str, object]

Read a JSON manifest and report malformed files as typed errors.

httk.core.docs.ecosystem.write_ecosystem_manifest(manifest: collections.abc.Mapping[str, object], output: str | pathlib.Path) → None

Write manifest as sorted, newline-terminated JSON using an atomic replace.

httk.core.docs.ecosystem.verify_ecosystem_manifest(submodules_dir: str | pathlib.Path, manifest_path: str | pathlib.Path, *, require_release_tags: bool = False) → None

Verify a committed manifest against the current checkout state.