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
@staticmethod
def get_ob_boost(ob): (source)

Undocumented

Parameters
ob:model.DocumentableUndocumented
Returns
intUndocumented
def format(self, ob, field): (source)

Undocumented

Parameters
ob:model.DocumentableUndocumented
field:strUndocumented
Returns
Optional[str]Undocumented
def format_docstring(self, ob): (source)

Undocumented

Parameters
ob:model.DocumentableUndocumented
Returns
Optional[str]Undocumented
def format_kind(self, ob): (source)

Undocumented

Parameters
ob:model.DocumentableUndocumented
Returns
strUndocumented
def format_name(self, ob): (source)

Undocumented

Parameters
ob:model.DocumentableUndocumented
Returns
strUndocumented
def format_names(self, ob): (source)

Undocumented

Parameters
ob:model.DocumentableUndocumented
Returns
strUndocumented
def format_qname(self, ob): (source)

Undocumented

Parameters
ob:model.DocumentableUndocumented
Returns
strUndocumented
def get_corpus(self): (source)

Undocumented

Returns
List[Tuple[Dict[str, Optional[str]], Dict[str, int]]]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': 4, 'names': 2, 'qname': 1, 'docstring': 1, 'kind': -1}