ml_switcheroo.utils.doc_context¶

Documentation Context Builder.

This module provides the logic to transform internal semantic definitions (from the SemanticsManager) into a structured View Model suitable for rendering documentation pages (ReStructuredText/HTML).

It handles: - formatting argument lists. - resolving implementation strategies (Direct vs Plugin vs Macro). - resolving documentation URLs via Framework Adapters.

Classes¶

DocContextBuilder

Prepares view data for operation documentation pages.

Module Contents¶

class ml_switcheroo.utils.doc_context.DocContextBuilder(semantics: ml_switcheroo.semantics.manager.SemanticsManager)[source]¶

Prepares view data for operation documentation pages.

semantics¶

build(op_name: str, definition: Dict[str, Any]) → Dict[str, Any][source]¶

Constructs the documentation context for a single operation.

Parameters:

op_name – The abstract operation ID (e.g. “Linear”).
definition – The raw dictionary definition from the SemanticsManager.

Returns:

A structural dictionary containing:

name (str)
description (str)
args (List[str]): Formatted signature strings.
variants (List[Dict]): Implementation details per framework.

Return type:

Dict