mkdocs.yml

site_name: Splinkclickhouse Documentation
site_url: https://adbond.github.io/splinkclickhouse
site_description: Documentation site for splinkclickhouse, the python package for powering the data-linking package Splink with the OLAP SQL engine Clickhouse
repo_name: splinkclickhouse
repo_url: https://github.com/ADBond/splinkclickhouse
edit_uri: blob/main/docs/

nav:
  - Home: index.md
  - Quickstart: quickstart.md
  - Engines:
    - Clickhouse server: engines/clickhouse_server.md
    - chdb: engines/chdb.md
  - Advanced usage: advanced.md
  - API:
    - Home: api/index.md
    - Comparison and Comparison Level Library: api/libraries.md
    - DatabaseAPI: api/database_api.md
  - Contributing: contributing.md
  - Version history: CHANGELOG.md

hooks:
  - docs/hooks/hooks.py
exclude_docs: "hooks/*"

theme:
  name: "material"
  palette:
    - scheme: default
      primary: green
      accent: deep orange
      toggle:
        icon: material/toggle-switch
        name: Switch to dark mode
    - scheme: slate
      primary: green
      accent: amber
      toggle:
        icon: material/toggle-switch-off-outline
        name: Switch to light mode
  features:
    - content.code.copy
    - content.code.select

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          options:
            heading_level: 3
            show_root_toc_entry: false
            show_bases: false
            merge_init_into_class: true
            show_source: false