snapvec/mkdocs.yml at main · stffns/snapvec · GitHub

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
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
site_name: snapvec
site_description: Fast compressed approximate nearest-neighbor search. NumPy + Cython.
site_url: https://stffns.github.io/snapvec/
repo_url: https://github.com/stffns/snapvec
repo_name: stffns/snapvec
edit_uri: edit/main/docs/

theme:
  name: material
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.sections
    - navigation.indexes
    - navigation.top
    - content.code.copy
    - content.code.annotate
    - search.suggest
    - search.highlight

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          options:
            show_source: false
            show_root_heading: true
            show_root_full_path: false
            show_signature_annotations: true
            separate_signature: true
            merge_init_into_class: true
            docstring_style: numpy
            members_order: source
            filters: ["!^_"]

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - toc:
      permalink: true
  - tables
  - attr_list

exclude_docs: |
  blog/

nav:
  - Home: index.md
  - Getting started:
      - Installation: getting-started/installation.md
      - Quickstart: getting-started/quickstart.md
  - User guide:
      - Choosing an index: user-guide/choosing-an-index.md
      - SnapIndex: user-guide/snap-index.md
      - PQSnapIndex: user-guide/pq.md
      - IVFPQSnapIndex: user-guide/ivf-pq.md
      - ResidualSnapIndex: user-guide/residual.md
      - Save and load: user-guide/save-load.md
      - Filtered search: user-guide/filter-search.md
      - Concurrency: user-guide/concurrency.md
  - Architecture: architecture.md
  - Benchmarks: benchmarks.md
  - API reference:
      - SnapIndex: api/snap-index.md
      - PQSnapIndex: api/pq.md
      - IVFPQSnapIndex: api/ivf-pq.md
      - ResidualSnapIndex: api/residual.md
      - Helpers: api/helpers.md
  - Decisions (ADRs):
      - Overview: adr/README.md
      - "0001: RHT off by default in PQ": adr/0001-rht-off-by-default-in-pq.md
      - "0002: early_stop for IVF probing parked": adr/0002-early-stop-for-ivf-probing-parked.md
      - "0003: OPQ-P over OPQ-NP": adr/0003-opq-p-over-opq-np.md
      - "0004: Cluster-contiguous codes": adr/0004-cluster-contiguous-column-major-codes.md
      - "0005: Memory-budget discipline": adr/0005-memory-budget-discipline.md
  - Changelog: changelog.md