orangeqs.juice.reporting.generate_output#

Generate the HTML report from the markdown template using pandoc.

Module Contents#

Functions#

generate_html

Use pandoc to turn the markdown template into an HTML file.

API#

orangeqs.juice.reporting.generate_output.generate_html(report_output_dir: str | pathlib.Path, *, markdown_filename: str | pathlib.Path | None = None, report_name: str = 'orangeqs_characterization_report') → str#

Use pandoc to turn the markdown template into an HTML file.

Parameters#

  • report_output_dir (str | Path): The output directory for the report

  • markdown_filename (str | Path, optional): The filename for the source markdown report. If None, it defauls to the value of the environment variable PANDOC_SOURCE_FN or “device_report.md”. If not absolute, it will be resolved relative to report_output_dir.

  • report_name (str, optional): The name of the report file to be generated. Defaults to “orangeqs_characterization_report”.

Returns#

  • (: str): The path to the generated HTML report. All files in the parent directory of the HTML file are required to view the report correctly.