Report generation

namespace snt

namespace dip

namespace report

Enums

enum class ReportFormat

Values:

enumerator Tex

enumerator Pdf

enumerator Markdown

enumerator Rst

enumerator Html

enumerator Typst

enumerator Text

enumerator Json

Functions

void generate(const dip::Environment &environment, ReportFormat format, const std::filesystem::path &output, const ReportOptions &options = {}): Generate a report from an already evaluated environment. Text formats need no external tool. PDF output invokes the configured TeX compiler.

struct ReportOptions

#include <report.h>

Public Members

std::string input_label: Label identifying the report input.

std::filesystem::path introduction_file: Optional trusted LaTeX fragment for TeX/PDF only.

std::string tex_compiler: Executable used only for PDF output.

std::string title: Report title.

std::string author: Report author; empty means unspecified.

std::string date: Report date; empty uses the generation date.

std::string version: Report version; empty uses the SNT version.

std::filesystem::path source_root: Show source paths relative to this directory when possible.