Framework for Python

Notebooks & Scripts

make_revealjs()

Create a Quarto reveal.js presentation.

The file starts from the "revealjs" stub.

Usage

make_revealjs(
    name: str,
    dir: str | Path | None = None,
    *,
    overwrite: bool = False,
    subdir: str | None = None,
) -> Path

Arguments

Name Type Default Description
name required str

The file name before slugifying, such as "Data Cleaning", which becomes data-cleaning.qmd.

dir str | Path | None None

The folder. Default: directories: notebooks or directories: work in the settings, then options: notebook_dir, then an existing notebooks/ or work/ folder, then the project root. The folder is created when missing.

overwrite bool False

Replace an existing file.

subdir str | None None

A subfolder of dir.

Value

The path of the new file.

Raises

  • FrameworkError: When the file exists and overwrite is False, or the stub is not found.