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 the 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): (source)

Get the all data to be writen into ``all-documents.html`` file.

Parameters
system:model.SystemUndocumented
Returns
List[Dict[str, Flattenable]]Undocumented
def stem_identifier(identifier): (source)

Undocumented

Parameters
identifier:strUndocumented
Returns
Iterator[str]Undocumented
def write_lunr_index(output_dir, system): (source)

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

Parameters
output_dir:PathOutput directory.
system:model.SystemSystem.
searchpages: List[Type[Page]] = (source)

Undocumented