pydoctor.templatewriter.search

module documentation

(source)

Code building ``all-documents.html``, ``searchindex.json`` and ``fullsearchindex.json``.

Class	`AllDocuments`	Undocumented
Class	`LunrIndexWriter`	Class to write lunr indexes with configurable fields.
Function	`get_all_documents_flattenable`	Get a generator for all data to be writen into ``all-documents.html`` file.
Function	`stem_identifier`	Undocumented
Function	`write_lunr_index`	Write ``searchindex.json`` and ``fullsearchindex.json`` to the output directory.
Variable	`searchpages`	Undocumented

def get_all_documents_flattenable(system: model.System) -> Iterator[dict[str, Flattenable]]: (source) ¶

Get a generator for all data to be writen into ``all-documents.html`` file.

def stem_identifier(identifier: str) -> Iterator[str]: (source) ¶

Undocumented

def write_lunr_index(output_dir: Path, system: model.System): (source) ¶

Write ``searchindex.json`` and ``fullsearchindex.json`` to the output directory.

searchpages: list[type[Page]] = (source) ¶

Undocumented