haive.core.utils.haive_discovery.documentation_writer¶

Documentation writer for saving discovered components.

Classes¶

Handles writing documentation for discovered components.

class haive.core.utils.haive_discovery.documentation_writer.DocumentationWriter[source]¶

Handles writing documentation for discovered components.

save_to_project_docs(components, project_root=None, subfolder='component_discovery')[source]¶

Save components to timestamped project documentation with separate files for each type.

Parameters:

components (list[haive.core.utils.haive_discovery.component_info.ComponentInfo])
project_root (str | None)
subfolder (str)

Return type:

dict[str, str]