mirar.utils.docs package

Util functions for documentation.

Submodules

mirar.utils.docs.auto_config_docs module

Module to auto-generate rst files for each pipeline in the project.

mirar.utils.docs.auto_config_docs.auto_rst_config(pipeline: str, config: str)

Function to generate a diagram summarising all BaseProcessor objects in a given pipeline configuration

Parameters:

• pipeline – Pipeline name

• config – Configuration name

Returns:

None

mirar.utils.docs.auto_config_docs.auto_rst_pipeline(pipeline: str, configs: list[str])

Function to generate a diagram summarising all BaseProcessor objects in a given pipeline configuration

Parameters:

• pipeline – Pipeline name

• configs – List of configurations

Returns:

None

mirar.utils.docs.auto_config_docs.auto_top_level_rst(pipelines: list[str])

Function to generate a top-level rst file for all pipelines

Returns:

None

mirar.utils.docs.auto_config_docs.get_rst_config_path(pipeline: str, config: str) → Path

Get output save path for a pipeline diagram

Parameters:

• pipeline – Pipeline ised

• config – Configs used

Returns:

path to save

mirar.utils.docs.auto_config_docs.get_rst_pipeline_path(pipeline: str) → Path

Get output save path for a pipeline diagram

Parameters:

pipeline – Pipeline name

Returns:

path to save

mirar.utils.docs.auto_config_docs.iterate_rst_generation()

Function to iterate the creation of a separate rst file for each pipeline

Returns:

None

mirar.utils.docs.pipeline_visualisation module

Module for generating visualisations of Pipeline objects.

mirar.utils.docs.pipeline_visualisation.flowify(processor_list: list[BaseProcessor], output_path: Path, include_stats: bool = False)

Function to generate a diagram summarising all BaseProcessor objects in a given pipeline configuration

Parameters:

• processor_list – list of processors to visualise

• output_path – Path to save diagram

• include_stats – Include statistics in diagram

Returns:

None

mirar.utils.docs.pipeline_visualisation.get_save_path(pipeline: str, configs: str) → Path

Get output save path for a pipeline diagram

Parameters:

• pipeline – Pipeline ised

• configs – Configs used

Returns:

path to save

mirar.utils.docs.pipeline_visualisation.iterate_flowify(config: str | list[str] | None = None, pipelines: str | list[str] | None = None)

Function to iterate the visualisation of all configurations and pipelines

Parameters:

• config – config(s) to visualise (default of all)

• pipelines – pipeline(s) to visualise

Returns:

None