pydoctor.templatewriter.search.LunrIndexWriter

class documentation

class LunrIndexWriter: (source)

View In Hierarchy

Class to write lunr indexes with configurable fields.

Static Method get_ob_boost Undocumented
Method format Undocumented
Method format_docstring Undocumented
Method format_kind Undocumented
Method format_name Undocumented
Method format_names Undocumented
Method format_qname Undocumented
Method get_corpus Undocumented
Method write Undocumented
Instance Variable fields Undocumented
Instance Variable output_file Undocumented
Instance Variable system Undocumented
Constant _BOOSTS Undocumented
Constant _SKIP_PIPELINES Undocumented
@staticmethod
def get_ob_boost(ob: model.Documentable) -> int: (source)

Undocumented

def format(self, ob: model.Documentable, field: str) -> str | None: (source)

Undocumented

def format_docstring(self, ob: model.Documentable) -> str | None: (source)

Undocumented

def format_kind(self, ob: model.Documentable) -> str: (source)

Undocumented

def format_name(self, ob: model.Documentable) -> str: (source)

Undocumented

def format_names(self, ob: model.Documentable) -> str: (source)

Undocumented

def format_qname(self, ob: model.Documentable) -> str: (source)

Undocumented

def get_corpus(self) -> list[tuple[dict[str, str | None], dict[str, int]]]: (source)

Undocumented

def write(self): (source)

Undocumented

fields: list[str] = (source)

Undocumented

output_file: Path = (source)

Undocumented

system: model.System = (source)

Undocumented

_BOOSTS: dict[str, int] = (source)

Undocumented

Value
{'name': 6, 'names': 1, 'qname': 2, 'docstring': 1, 'kind': -1}
_SKIP_PIPELINES = (source)

Undocumented

Value
list(_BOOSTS)