sift/python/mkdocs.yml at main · sift-stack/sift · 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
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
site_name: Sift | Python Client Library
site_url: https://sift-stack.github.io/sift/python/
repo_url: https://github.com/sift-stack/sift/tree/main/python
copyright: "Copyright 2025 Sift Stack, Inc."
theme:
  name: material
  custom_dir: docs/overrides
  favicon: stylesheets/dark-favicon.ico
  palette:
    # Palette toggle for automatic mode
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode
    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-4
        name: Switch to system preference
  logo_light_mode: stylesheets/sift_logo_light.svg
  logo_dark_mode: stylesheets/sift_logo_dark.svg
  font:
    text: IBM Plex Sans
    code: IBM Plex Mono
  features:
    - navigation.instant
    - navigation.instant.progress
    - navigation.tabs
    - navigation.sections
    - navigation.tracking
    - navigation.prune
    - toc.follow
    #    - toc.integrate
    - navigation.top
    - search.suggest
    - content.code.copy

extra:
  version:
    provider: mike
    alias: true

nav:
  - Home: index.md
  - Sift Client API
  - Sift Py API
  - Examples:
      - examples/index.md
      - Basic Usage: examples/basic.ipynb
      - Data Ingestion: examples/ingestion.ipynb
      - Pytest Plugin: examples/pytest_plugin.md
#  - Guides:
#      - Logging
#      - Error Handling

plugins:
  - search
  - autorefs
  - mike: # For docs versioning
      deploy_prefix: 'python' # In case we want to use doc sites for other client libs too
  - mkdocs-jupyter:
      include_source: True
      execute: False
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          import:
            - https://docs.python.org/3/objects.inv
            - https://docs.pydantic.dev/latest/objects.inv
          options:
            show_docstring_examples: false
            load_external_modules: true
            show_source: false
            find_stubs_package: true
            show_if_no_docstring: true
            filters: ["!^__(?!init)", "!^_[^_]"]
            show_submodules: false
            # Styling
            group_by_category: true
            docstring_section_style: spacy
            docstring_style: "google"
            heading_level: 1
            merge_init_into_class: true
            separate_signature: true
            show_root_heading: true
            show_signature_annotations: true
            signature_crossrefs: true
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            summary: true
            inherited_members: true
            # Custom Griffe extension to inspect the sync stubs and generate their signatures
            extensions:
              - griffe_extensions/sync_stubs_inspector.py:InspectSpecificObjects:
                  paths:
                    - sift_client.resources.sync_stubs
              - griffe_pydantic:
                  schema: false

  - api-autonav:
      nav_section_title: Sift Py API
      modules: [ lib/sift_py ]
      exclude_private: true
      nav_item_prefix: ""

  - api-autonav:
      nav_section_title: Sift Client API
      modules: [ lib/sift_client ]
      exclude_private: true
      nav_item_prefix: ""


markdown_extensions:
  - admonition
  - toc:
      permalink: true
      title: On this page
  - pymdownx.details
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences


extra_css:
  - stylesheets/extra.css