This commit is contained in:
maxbachmann 2020-05-27 09:42:58 +02:00
parent a2b4dd3b5e
commit aaa3b34948
No known key found for this signature in database
GPG Key ID: 60334E83C23820B8
4 changed files with 16 additions and 20 deletions

View File

@ -1,20 +1,19 @@
.. RapidFuzz documentation master file, created by
sphinx-quickstart on Sat May 9 19:17:06 2020.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
RapidFuzz Installation
Installation
=====================================
RapidFuzz can be installed using `pip <https://pypi.org/project/rapidfuzz/>`_.
.. tabs::
.. code-block:: bash
.. tab:: Python
pip install rapidfuzz
RapidFuzz can be installed using `pip <https://pypi.org/project/rapidfuzz/>`_.
There are pre-built binaries (wheels) for ``RapidFuzz`` and its dependencies for MacOS (10.9 and later), Linux x86_64 and Windows.
.. code-block:: bash
For any other architecture/OS, ``RapidFuzz`` can be installed from the source distribution. To do so, a C++14 capable compiler must be installed before running the ``pip install rapidfuzz`` command. While Linux and MacOs usually come with a compiler it is required to install `C++-Buildtools <https://visualstudio.microsoft.com/visual-cpp-build-tools>`_ on Windows.
pip install rapidfuzz
There are pre-built binaries (wheels) for ``RapidFuzz`` and its dependencies for MacOS (10.9 and later), Linux x86_64 and Windows.
For any other architecture/OS, ``RapidFuzz`` can be installed from the source distribution. To do so, a C++14 capable compiler must be installed before running the ``pip install rapidfuzz`` command. While Linux and MacOs usually come with a compiler it is required to install `C++-Buildtools <https://visualstudio.microsoft.com/visual-cpp-build-tools>`_ on Windows.
.. toctree::

View File

@ -1,9 +1,4 @@
.. RapidFuzz documentation master file, created by
sphinx-quickstart on Sat May 9 19:17:06 2020.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
RapidFuzz Usage
Usage
=====================================
.. code-block:: console

View File

@ -37,14 +37,14 @@ html_theme_options = {
"fixed_sidebar": True,
'logo': 'RapidFuzz.svg',
"description": ("Rapid fuzzy string matching in Python and C++ using the "
"description": ("Rapid fuzzy string matching using the "
"Levenshtein Distance"),
"sidebar_collapse": True,
"show_relbar_bottom": True,
"show_powered_by": False,
# 'github_user': "maxbachmann",
# 'github_repo': "rapidfuzz",
'github_user': "maxbachmann",
'github_repo': "rapidfuzz",
# "github_button": True,
# "github_type": "count",
# "github_banner": True,
@ -56,6 +56,7 @@ html_theme_options = {
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
'sphinx_tabs.tabs'
]
# Add any paths that contain templates here, relative to this directory.

1
docs/requirements.txt Normal file
View File

@ -0,0 +1 @@
sphinx-tabs==1.1.13