jellyfish/docs/index.rst

40 lines
814 B
ReStructuredText
Raw Normal View History

2015-02-24 21:42:05 +00:00
jellyfish |release|
===================
Overview
--------
jellyfish is a library of functions for approximate and phonetic matching of strings.
The library provides implementations of the following algorithms:
2015-02-24 21:42:05 +00:00
.. toctree::
:maxdepth: 3
2015-02-24 21:42:05 +00:00
phonetic
stemming
comparison
2015-04-22 19:53:14 +00:00
changelog
2015-02-24 21:42:05 +00:00
Implementation
--------------
2015-02-24 21:42:05 +00:00
2015-02-27 06:02:37 +00:00
Each algorithm has C and Python implementations.
2015-02-24 21:42:05 +00:00
On a typical CPython install the C implementation will be used. The Python versions
are available for PyPy and systems where compiling the CPython extension is not
possible.
To explicitly use a specific implementation, refer to the appropriate module::
import jellyfish._jellyfish as pyjellyfish
import jellyfish.cjellyfish as cjellyfish
2015-02-24 21:42:05 +00:00
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`