couchbase-haystack/mkdocs.yaml at main · Couchbase-Ecosystem/couchbase-haystack · 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
site_name: "Couchbase Haystack Integration"
site_description: "Haystack Document Store for Couchbase."
site_url: "https://couchbase-ecosystem.github.io/couchbase-haystack/"
repo_url: "https://github.com/couchbase-ecosystem/couchbase-haystack"
repo_name: "couchbase-ecosystem/couchbase-haystack"
site_dir: "site"
watch:
  - README.md
  - CHANGELOG.md
  - src

nav:
  - Home:
    - Overview: index.md
    - Changelog: changelog.md
    - License: license.md
  - Code Reference:
    - CouchbaseSearchDocumentStore: reference/document_stores/document_store.md
    - Authentication: reference/document_stores/auth.md
    - CouchbaseClusterOptions: reference/document_stores/cluster_options.md
    - Retrievers:
      - CouchbaseSearchEmbeddingRetriever: reference/components/retrievers/embedding_retriever.md
    - Filters: reference/document_stores/filters.md
  - Haystack Documentation: https://docs.haystack.deepset.ai/v2.0/docs/intro

theme:
  name: material
  logo: assets/logo.svg
  favicon: assets/logo.svg
  features:
    - navigation.tabs
    - navigation.tabs.sticky
  palette:
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: custom
      accent: custom
      toggle:
        icon: material/weather-night
        name: Switch to light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: custom
      accent: custom
      toggle:
        icon: material/weather-sunny
        name: Switch to dark mode

extra_css:
  - stylesheets/mkdocstrings.css

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets:
      check_paths: true
  - attr_list
  - toc:
      permalink: "¤"

plugins:
  - search
  - section-index
  - mkdocstrings:
      handlers:
        python:
          paths: [src]
          import:
            - https://docs.python.org/3/objects.inv
            - https://mkdocstrings.github.io/objects.inv
            - https://mkdocstrings.github.io/griffe/objects.inv
            - https://docs.couchbase.com/sdk-api/couchbase-python-client/objects.inv
          options:
            docstring_options:
              ignore_init_summary: yes
            merge_init_into_class: no
            separate_signature: true
            show_signature_annotations: true
            line_length: 80
            show_source: yes
            show_root_full_path: no
            docstring_section_style: list
            annotations_path: brief
            members_order: source
            filters: [] # show private methods

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/prosto