httk.core.docs.config

Load the strict docs/versioning.toml site configuration.

The supported shape is:

[site]
slug = "httk-atomistic"
repository-url = "https://github.com/httk/httk-atomistic"
main-branch = "main"
import-roots = ["httk/atomistic", "httk/handlers"]

[[internal-dependency]]
distribution = "httk-core"
slug = "httk-core"
repository-url = "https://github.com/httk/httk-core"
main-branch = "main"

Exceptions

ConfigError

Raised when a versioning TOML file is missing, malformed, or unsafe.

Classes

InternalDependency	Documentation-site metadata for one internal httk distribution.
VersioningConfig	Configuration for one versioned documentation site.

Functions

load_versioning_config(→ VersioningConfig)

Read and validate a versioning TOML file, rejecting unknown keys.

Module Contents

exception httk.core.docs.config.ConfigError

Bases: ValueError

Raised when a versioning TOML file is missing, malformed, or unsafe.

class httk.core.docs.config.InternalDependency

Documentation-site metadata for one internal httk distribution.

distribution: str

slug: str

repository_url: str

main_branch: str = 'main'

class httk.core.docs.config.VersioningConfig

Configuration for one versioned documentation site.

slug: str

repository_url: str

main_branch: str = 'main'

import_roots: tuple[str, Ellipsis] = ()

internal_dependencies: tuple[InternalDependency, Ellipsis] = ()

httk.core.docs.config.load_versioning_config(path: str | pathlib.Path) → VersioningConfig

Read and validate a versioning TOML file, rejecting unknown keys.