httk.core.docs.release

Release-tag checks, lock validation, and deterministic documentation URLs.

When docs/versioning.toml is present, release checks assume each internal repository’s Sphinx project name equals its configured documentation slug and validate the corresponding committed docs/_inventories/<slug>.inv header.

Exceptions

ReleaseError

Raised when a release tag, project version, or documentation lock is invalid.

Classes

ReleaseCheck

Summary of a successful release preflight.

Functions

check_release(→ ReleaseCheck)	Validate a release tag against pyproject.toml and its docs lock.
dependency_doc_targets(→ dict[str, str])	Derive exact release or dev/main inventory URLs for internal dependencies.

Module Contents

exception httk.core.docs.release.ReleaseError

Bases: RuntimeError

Raised when a release tag, project version, or documentation lock is invalid.

class httk.core.docs.release.ReleaseCheck

Summary of a successful release preflight.

tag: str

version: httk.core.docs.semver.Version

lock_path: pathlib.Path

httk.core.docs.release.check_release(project_dir: str | pathlib.Path, tag: str) → ReleaseCheck

Validate a release tag against pyproject.toml and its docs lock.

httk.core.docs.release.dependency_doc_targets(config: httk.core.docs.config.VersioningConfig, pins: collections.abc.Mapping[str, str], base_url: str, channel: str) → dict[str, str]

Derive exact release or dev/main inventory URLs for internal dependencies.