Skip to content

zensical

zensical documentation

footman._stubs.zensical.Zensical

Bases: Tool

build

build(
    *,
    clean: _Flag = ...,
    config_file: _Value = ...,
    strict: _Flag = ...,
    **flags: Any,
) -> Result

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.

...

flags

flags(**flags: Any) -> Zensical

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.

new

new(*args: str, **flags: Any) -> Result

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

serve

serve(
    *,
    config_file: _Value = ...,
    dev_addr: _Value = ...,
    open: _Flag = ...,
    strict: _Flag = ...,
    **flags: Any,
) -> Result

Build and serve a project.

Parameters:

Name Type Description Default
config_file _Value

Path to config file.

...
dev_addr _Value

IP address and port (default: localhost:8000).

...
open _Flag

Open preview in default browser.

...
strict _Flag

Strict mode (currently unsupported).

...