Loads and parses the mandatory sidebar.toml from doc_dir.

Raises: UdeException: If sidebar.toml is absent, unreadable, malformed, or tomllib is unavailable.

Returns:

Parsed TOML content as a dict.

Methods

load_sidebar_toml

load_sidebar_toml(doc_dir: Path) -> dict

Loads and parses the mandatory sidebar.toml from doc_dir.

Raises: UdeException: If sidebar.toml is absent, unreadable, malformed, or tomllib is unavailable.

Returns:

Parsed TOML content as a dict.

ParameterTypeDescription
doc_dirPathDirectory that must contain sidebar.toml.

Generated with Flude

Copyright © 2026