Skip to content

zensical

zensical documentation

Zensical

Bases: Tool[_R]

Classes:

Name Description
Build
New
Serve

Methods:

Name Description
__call__

Zensical - A modern static site generator.

flags

Bind tool-level global options before the subcommand.

Attributes:

Name Type Description
build Build[_R]
new New[_R]
serve Serve[_R]
argv Zensical[Argv]

build instance-attribute

build: Build[_R]

new instance-attribute

new: New[_R]

serve instance-attribute

serve: Serve[_R]

argv property

argv: Zensical[Argv]

Build

Bases: Tool[_R2]

Methods:

Name Description
__call__

Build a project.

Attributes:

Name Type Description
argv Build[Argv]

argv property

argv: Build[Argv]

__call__

__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.

...

New

Bases: Tool[_R2]

Methods:

Name Description
__call__

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

Attributes:

Name Type Description
argv New[Argv]

argv property

argv: New[Argv]

__call__

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

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

Serve

Bases: Tool[_R2]

Methods:

Name Description
__call__

Build and serve a project.

Attributes:

Name Type Description
argv Serve[Argv]

argv property

argv: Serve[Argv]

__call__

__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__

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

Zensical - A modern static site generator.

flags

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.