File: highlight.rst

package info (click to toggle)
python-whoosh 2.7.4%2Bgit6-g9134ad92-4
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 3,648 kB
  • sloc: python: 38,517; makefile: 118
file content (50 lines) | stat: -rw-r--r-- 751 bytes parent folder | download | duplicates (9)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
====================
``highlight`` module
====================

.. automodule:: whoosh.highlight

See :doc:`how to highlight terms in search results </highlight>`.


Manual highlighting
===================

.. autoclass:: Highlighter
   :members:

.. autofunction:: highlight


Fragmenters
===========

.. autoclass:: Fragmenter
   :members:

.. autoclass:: WholeFragmenter
.. autoclass:: SentenceFragmenter
.. autoclass:: ContextFragmenter
.. autoclass:: PinpointFragmenter


Scorers
=======

.. autoclass:: FragmentScorer
.. autoclass:: BasicFragmentScorer


Formatters
==========

.. autoclass:: UppercaseFormatter
.. autoclass:: HtmlFormatter
.. autoclass:: GenshiFormatter


Utility classes
===============

.. autoclass:: Fragment
    :members: