Doc

Generators for documentation.

generate(context, output)

Generate documentation files.

Parameters:

Name	Type	Description	Default
context	dict	the context as a dict (read doc/context.md).	required
output	Path	directory to write output files.	required

Source code in kcg/generators/doc.py

def generate(context: dict, output: pathlib.Path) -> None:
    """Generate documentation files.

    Args:
        context (dict): the context as a dict (read doc/context.md).
        output (pathlib.Path): directory to write output files.
    """
    name = context["basic_info"]["name"]
    run_perl_script(context, "description", output.joinpath(f"{name}-desc.html"))