diff --git a/docs/_packages/installation.rst b/docs/_packages/installation.rst index 7a21477..5fa78e9 100644 --- a/docs/_packages/installation.rst +++ b/docs/_packages/installation.rst @@ -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 `_. +.. tabs:: -.. code-block:: bash + .. tab:: Python - pip install rapidfuzz + RapidFuzz can be installed using `pip `_. -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 `_ 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 `_ on Windows. .. toctree:: diff --git a/docs/_packages/usage.rst b/docs/_packages/usage.rst index 2515881..56abe25 100644 --- a/docs/_packages/usage.rst +++ b/docs/_packages/usage.rst @@ -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 diff --git a/docs/conf.py b/docs/conf.py index aa6de98..9f45a6a 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -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. diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 0000000..0fa91cd --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1 @@ +sphinx-tabs==1.1.13 \ No newline at end of file