zensical¶

toolroom._stubs.zensical.Zensical ¶

Bases: Tool[_R]

Bases: Tool[_R2]

__call__(
    *,
    clean: Flag = ...,
    config_file: Value = ...,
    strict: Flag = ...,
    **flags: Any,
) -> _R2

Build a project.

Parameters:

Name	Type	Description	Default
`clean`	`Flag`	Clean cache.	`...`
`config_file`	`Value`	Path to config file.	`...`
`strict`	`Flag`	Enable strict mode - abort the build on warnings.	`...`

Bases: Tool[_R2]

__call__(*args: str | PathLike[str], **flags: Any) -> _R2

Create a new template project in the current or given directory.

Bases: Tool[_R2]

__call__(
    *,
    config_file: Value = ...,
    dev_addr: Value = ...,
    open: Flag = ...,
    strict: Flag = ...,
    **flags: Any,
) -> _R2

Build and serve a project.

Parameters:

Name	Type	Description	Default
`config_file`	`Value`	Path to config file.	`...`
`dev_addr`	`Value`	IP address and port. Defaults to `localhost:8000`.	`...`
`open`	`Flag`	Open preview in default browser.	`...`
`strict`	`Flag`	Strict mode (currently unsupported).	`...`

__call__(*args: str | PathLike[str], **flags: Any) -> _R

Zensical - A modern static site generator.

flags(**flags: Any) -> Self

Bind tool-level global options before the subcommand.

tools.docker.flags(host=...) puts a tool's own options ahead of the verb, where they belong.