folio.generator.sidebar source

Functions

_meta_value_to_ts source

def _meta_value_to_ts(value: Any, *, indent: int = 2) -> list[str]

Returns: list[str] -

_meta_to_ts source

def _meta_to_ts(meta: dict[str, Any]) -> str

Convert a meta dict to a TypeScript export default \{ ... \} string.

Returns: str -

_slugify source

def _slugify(text: str) -> str

Convert a nav item to a URL-friendly slug.

Returns: str -

generate_meta_json source

def generate_meta_json(nav: list[str]) -> str

Convert nav items to a Nextra _meta.ts string with slugified keys.

Returns: str -

_build_module_tree source

def _build_module_tree(modules: list[ModuleIR]) -> dict

Build a nested tree from dotted module names.

Returns a dict where keys are path segments and values are either nested dicts (intermediate nodes) or None (leaf modules).

Returns: dict -

_title_case source

def _title_case(slug: str) -> str

Convert a slug to a human-readable title.

Returns: str -

_generate_meta_from_tree source

def _generate_meta_from_tree(tree: dict, path_prefix: str, result: dict[str, str], *, include_index: bool = False) -> None

Recursively generate _meta.ts files from a module tree.

Returns: None -

_generate_doc_meta source

def _generate_doc_meta(docs: list[MarkdownResult]) -> tuple[dict[str, str], dict[str, str]]

Generate ordered doc page entries for the root and subdirectory _meta.ts.

Returns (root_meta, extra_meta_files) where:

• root_meta: dict of slug -> title for the root _meta.ts
• extra_meta_files: dict of path -> ts_content for subdirectory _meta.ts files

Returns: tuple[dict[str, str], dict[str, str]] -

generate_meta_files source

def generate_meta_files(nav: list[str], modules: list[ModuleIR], docs: list[MarkdownResult] | None = None) -> dict[str, str]

Generate all _meta.ts files needed (root + docs + api-reference).

Returns a dict mapping file paths (relative) to their TS content.

Returns: dict[str, str] -