usearch 2.1.2

Smaller & Faster Single-File Vector Search Engine from Unum
Documentation 
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
51
52
53

# Configuration file for the Sphinx documentation builder.
#
# For the full list of built-in configuration values, see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html

# -- Project information -----------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information

project = "Unum ยท USearch"
copyright = "2023, Unum"
author = "Unum"
release = open("../VERSION", "r").read().strip()
with open("_static/custom.js", "r+") as js:
    content = js.read()
    js.seek(0)
    js.truncate()
    js.write(content.replace("$(VERSION)", release))

# -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

extensions = [
    "breathe",
    "m2r2",
    "sphinx.ext.autodoc",
    "sphinx_js",
    "sphinx.ext.autosummary",
    "sphinx.ext.intersphinx",
    "sphinx.ext.napoleon",
    "sphinxcontrib.jquery",
    "sphinxcontrib.googleanalytics",
]

exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", "*.md"]


googleanalytics_id = "341385789"
googleanalytics_enabled = True

# -- Options for HTML output -------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output

html_logo = "../assets/unum.png"
html_theme = "furo"
html_static_path = ["_static"]
html_css_files = ["custom.css"]
html_js_files = ["custom.js"]
html_baseurl = "/docs/usearch/"

breathe_projects = {"USearch": "../build/xml"}
breathe_default_project = "USearch"

js_source_path = "../javascript/docs.js"