httk.core.docs.manifests

JSON manifests used by the documentation site’s root and selector.

Functions

build_version_manifest(→ dict[str, Any])	Build a root manifest with releases newest-first and optional dev last.
write_version_manifest(→ None)	Write one JSON version manifest using stable, human-readable formatting.
read_version_manifest(→ dict[str, Any])	Read a JSON version manifest from path.
build_page_manifest(→ dict[str, Any])	List every HTML page below html_dir as sorted POSIX paths.
write_page_manifest(→ None)	Write one per-version page manifest.

Module Contents

httk.core.docs.manifests.build_version_manifest(slug: str, url: str, source_commit: str | None, release_versions: list[httk.core.docs.semver.Version] | tuple[httk.core.docs.semver.Version, Ellipsis], has_dev: bool) → dict[str, Any]

Build a root manifest with releases newest-first and optional dev last.

httk.core.docs.manifests.write_version_manifest(path: str | pathlib.Path, manifest: dict[str, Any]) → None

Write one JSON version manifest using stable, human-readable formatting.

httk.core.docs.manifests.read_version_manifest(path: str | pathlib.Path) → dict[str, Any]

Read a JSON version manifest from path.

httk.core.docs.manifests.build_page_manifest(version_name: str, html_dir: str | pathlib.Path) → dict[str, Any]

List every HTML page below html_dir as sorted POSIX paths.

httk.core.docs.manifests.write_page_manifest(path: str | pathlib.Path, manifest: dict[str, Any]) → None

Write one per-version page manifest.