build

build(
    source: str = 'datapackage.json',
    style: Style = Style.quarto_one_page,
    template_dir: Optional[Path] = None,
    output_dir: Path = Path('docs'),
    verbose: bool = False,
)

Build human-readable documentation from a datapackage.json file.

Parameters

source : str = 'datapackage.json'

The location of a datapackage.json, defaults to a file or folder path. Can also be an https: source to a remote datapackage.json or a github: / gh: pointing to a repo with a datapackage.json in the repo root (in the format gh:org/repo, which can also include reference to a tag or branch, such as gh:org/repo@main or gh:org/repo@1.0.1).

style : Style = Style.quarto_one_page

The style used to structure the output. If a template directory is given, this parameter will be ignored.

template_dir : Optional[Path] = None

The directory that contains the Jinja template files and sections.toml. When set, it will override any built-in style given by the style parameter.

output_dir : Path = Path('docs')

The directory to save the generated files in.

verbose : bool = False

If True, prints additional information to the console.