vgi-python/mkdocs.yml at main · Query-farm/vgi-python · 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
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
site_name: vgi-python
site_description: "vgi-python: extend DuckDB with functions written in Python (or any language) over Apache Arrow IPC — scalar, table, table-in-out, and aggregate functions, catalogs, and stateful workers"
site_url: https://vgi-python.query.farm/
repo_url: https://github.com/Query-farm/vgi-python
repo_name: Query-farm/vgi-python
copyright: "&copy; 2026 <a href=\"https://query.farm\">Query.Farm LLC</a>"

extra:
  social:
    - icon: material/web
      link: https://query.farm
      name: 🚜 Query.Farm
    - icon: material/arrow-right-bold-circle
      link: https://vgi-rpc-python.query.farm/
      name: vgi-rpc (RPC layer)
    - icon: fontawesome/brands/github
      link: https://github.com/Query-farm
      name: 🚜 Query.Farm on GitHub

extra_css:
  - stylesheets/extra.css

theme:
  name: material
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: custom
      accent: custom
      toggle:
        icon: material/weather-sunny
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: custom
      accent: custom
      toggle:
        icon: material/weather-night
        name: Switch to light mode
  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.indexes
    - navigation.top
    - navigation.footer
    - content.code.copy
    - search.highlight
    - search.suggest
    - toc.follow
  font:
    text: Inter
    code: JetBrains Mono
  custom_dir: docs/overrides
  logo: assets/logo.png
  favicon: assets/favicon.ico
  icon:
    repo: fontawesome/brands/github

markdown_extensions:
  - toc:
      permalink: true
      toc_depth: 3
  - tables
  - admonition
  - pymdownx.details
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.snippets:
      base_path: .
  - attr_list
  - md_in_html

plugins:
  - search
  - section-index
  - d2:
      layout: dagre
      theme: 104
      dark_theme: 200
      pad: 100
      cache: true
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          paths: [.]
          options:
            show_source: true
            show_bases: true
            show_root_heading: true
            show_root_full_path: false
            show_symbol_type_heading: true
            show_symbol_type_toc: false
            heading_level: 2
            members_order: source
            show_if_no_docstring: false
            docstring_style: google
            docstring_section_style: spacy
            merge_init_into_class: true
            show_signature: true
            show_signature_annotations: true
            separate_signature: true
            signature_crossrefs: true
            relative_crossrefs: true
            scoped_crossrefs: true

nav:
  - Home: index.md
  - Tutorial:
    - tutorial/index.md
    - 1. Scalar function: tutorial/scalar.md
    - 2. Table function: tutorial/table.md
  - How-to guides:
    - how-to/index.md
    - Function patterns: how-to/function-patterns.md
    - Expose a catalog: how-to/catalogs.md
    - Persist state across workers: how-to/state-storage.md
    - Serve over HTTP with auth: how-to/http-auth.md
    - Integrate with the optimizer: how-to/pushdown-and-statistics.md
    - Function Metadata: metadata.md
    - CLI: cli.md
    - "Reference: Function API": generator-api.md
    - "Reference: Aggregate Functions": aggregate-functions.md
    - "Reference: Catalog Interface": catalog-interface.md
    - "Reference: Shared Storage": shared-storage.md
    - "Reference: Authentication": authentication.md
    - "Reference: Filter Pushdown": filter-pushdown.md
    - "Reference: Column Statistics": column-statistics.md
  - Concepts:
    - concepts/index.md
    - Function Lifecycle: lifecycle.md
    - Argument Serialization: argument-serialization.md
  - API Reference:
    - api/index.md
    - Functions: api/functions.md
    - Arguments & Schema: api/arguments.md
    - Worker & Serving: api/worker.md
    - Client: api/client.md
    - Catalogs: api/catalogs.md
    - State Storage: api/storage.md
    - Metadata & Protocol: api/metadata.md
    - Filter Pushdown: api/filters.md
    - Auth & Secrets: api/auth.md
    - Observability: api/observability.md
    - HTTP: api/http.md
    - Transactor: api/transactor.md
    - Exceptions: api/exceptions.md
  - Contributing to docs: contributing-docs.md