From 607cd73206278b2701fb7b3755450a2ff6f2084b Mon Sep 17 00:00:00 2001 From: Max Bachmann Date: Sun, 11 Dec 2022 16:01:09 +0100 Subject: [PATCH] add better start page in docs --- docs/License.rst | 2 ++ docs/index.rst | 33 +++++++++++++++++++++++++++++++-- 2 files changed, 33 insertions(+), 2 deletions(-) diff --git a/docs/License.rst b/docs/License.rst index b1dc9ba4..6575e201 100644 --- a/docs/License.rst +++ b/docs/License.rst @@ -1,3 +1,5 @@ +.. _my-license-label: + License ======= diff --git a/docs/index.rst b/docs/index.rst index 54e938c5..fd9855b1 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,5 +1,32 @@ -RapidFuzz -========= +|header-image| +================= + +RapidFuzz performs fuzzy string matching between two or more sequences using various string metrics. + +Fundamental algorithms +---------------------- +RapidFuzz provides a wide range of fundamental algorithms for string matching. +In addition it provides an API compatible implementation of all algorithms in ``thefuzz`` \/ ``fuzzywuzzy``. + +Performant +---------- +Rapidfuzz wraps highly-optimized implementations written in C++. +Enjoy the flexibility of Python with the speed of compiled code. + +Easy to use +----------- +RapidFuzz's high level syntax makes it accessible and productive for programmers +from any background or experience level. + +Compatible +---------- +RapidFuzz provides a pure python fallback for every algorithm. This ensures that the library works on platforms +where compiling a C extension is not possible. + +Open source +----------- +Distributed under a :ref:`MIT License `, RapidFuzz is developed and maintained `publicly on GitHub `_. + .. toctree:: :hidden: @@ -16,3 +43,5 @@ RapidFuzz License References GitHub Repository + +.. |header-image| image:: img/RapidFuzz.svg \ No newline at end of file