vgi-rpc-python/mkdocs.yml at main · Query-farm/vgi-rpc-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
site_name: vgi-rpc
site_description: "vgi-rpc: a transport-agnostic Python RPC framework built on Apache Arrow IPC — typed proxies, streaming, shared memory, HTTP, and external storage"
site_url: https://vgi-rpc-python.query.farm/
repo_url: https://github.com/Query-farm/vgi-rpc-python
repo_name: Query-farm/vgi-rpc-python
copyright: "&copy; 2026 <a href=\"https://query.farm\">Query.Farm LLC</a>"

extra:
  social:
    - icon: material/arrow-right-bold-circle
      link: https://vgi-rpc.query.farm
      name: vgi-rpc website
    - icon: material/web
      link: https://query.farm
      name: 🚜 Query.Farm
    - 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

nav:
  - Home: index.md
  - API Reference:
    - api/index.md
    - Core RPC: api/core.md
    - Streaming: api/streaming.md
    - Auth & Context: api/auth.md
    - Transports: api/transports.md
    - HTTP: api/http.md
    - Serialization: api/serialization.md
    - Introspection: api/introspection.md
    - External Storage: api/external.md
    - Logging: api/logging.md
    - OpenTelemetry: api/otel.md
    - CLI: api/cli.md
  - Examples: examples.md
  - Hosting: hosting.md
  - Benchmarks: benchmarks.md
  - Comparison: comparison.md
  - Contributing: contributing.md