betty.extension.cotton_candy.search module¶

Provide Cotton Candy’s search functionality.

class betty.extension.cotton_candy.search.Index[source]¶

Bases: object

Build search indexes.

Parameters:

project (betty.project.Project)
job_context (betty.job.Context | None)
localizer (betty.locale.Localizer)

__init__(project: betty.project.Project, job_context: betty.job.Context | None, localizer: betty.locale.Localizer)[source]¶

Parameters:

project (betty.project.Project)
job_context (betty.job.Context | None)
localizer (betty.locale.Localizer)

async build() → collections.abc.AsyncIterable[dict[str, str]][source]¶

Build the search index.

Return type:: collections.abc.AsyncIterable[dict[str, str]]