httk.core.docs.sitetree

Compose immutable release and replaceable development documentation trees.

Exceptions

ComposeError	Raised when a documentation tree contains unsafe or unsupported entries.
ImmutabilityError	Raised when a rebuild differs from an already published release tree.

Classes

ComposeResult

Summary of one site composition operation.

Functions

compose_site(→ ComposeResult)

Compose a docs-site tree while preserving all existing release directories.

Module Contents

exception httk.core.docs.sitetree.ComposeError

Bases: RuntimeError

Raised when a documentation tree contains unsafe or unsupported entries.

exception httk.core.docs.sitetree.ImmutabilityError

Bases: RuntimeError

Raised when a rebuild differs from an already published release tree.

class httk.core.docs.sitetree.ComposeResult

Summary of one site composition operation.

changed: bool

unchanged: bool

default_target: str

versions: tuple[str, Ellipsis]

httk.core.docs.sitetree.compose_site(site_root: pathlib.Path, build_html: pathlib.Path, *, slug: str, site_url: str, source_commit: str | None, target: httk.core.docs.semver.Version | Literal['dev'], repair: bool = False) → ComposeResult

Compose a docs-site tree while preserving all existing release directories.

repair=True is reserved for replacing an existing release after an approved manual repair. The replacement uses the same rename transaction as the development swap and never removes the live release in place.