jellycell.cli.commands.render

jellycell render — generate the HTML catalogue under site/.

Module Contents

Classes

RenderedEntry

One rendered notebook entry.

RenderReport

JSON schema for jellycell render --json. Spec §10.1 contract.

Functions

render

Generate the HTML catalogue from cached manifests.

API

class jellycell.cli.commands.render.RenderedEntry(/, **data: Any)

Bases: pydantic.BaseModel

One rendered notebook entry.

Initialization

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

notebook: str

None

output_path: str

None

cell_count: int

None

cached_count: int

None

class jellycell.cli.commands.render.RenderReport(/, **data: Any)

Bases: pydantic.BaseModel

JSON schema for jellycell render --json. Spec §10.1 contract.

Initialization

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

schema_version: int

1

project: str

None

index: str | None

None

entries: list[jellycell.cli.commands.render.RenderedEntry]

‘Field(…)’

jellycell.cli.commands.render.render(ctx: typer.Context, notebook: pathlib.Path | None = typer.Argument(None, help='Notebook to render. Omit to render the whole project + index.'), standalone: bool = typer.Option(False, '--standalone', help='Base64-inline image assets for a self-contained HTML file.')) None

Generate the HTML catalogue from cached manifests.