pyspark-client-wasm/mkdocs.yml at main · HyukjinKwon/pyspark-client-wasm · 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
# SPDX-License-Identifier: Apache-2.0
site_name: pyspark-connect-web
site_description: "PySpark in JupyterLite - run the real PySpark Connect client in the browser over grpc-web."
site_author: Hyukjin Kwon
site_url: https://hyukjinkwon.github.io/pyspark-client-wasm/

repo_name: HyukjinKwon/pyspark-client-wasm
repo_url: https://github.com/HyukjinKwon/pyspark-client-wasm
edit_uri: edit/main/docs/

copyright: "Licensed under Apache-2.0."

theme:
  name: material
  language: en
  font:
    text: Inter
    code: JetBrains Mono
  icon:
    repo: fontawesome/brands/github
    logo: material/language-python
  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.top
    - navigation.indexes
    - navigation.footer
    - navigation.instant
    - navigation.instant.progress
    - navigation.tracking
    - toc.follow
    - content.code.copy
    - content.code.annotate
    - content.tooltips
    - search.suggest
    - search.highlight
    - search.share
  palette:
    # Python brand: blue + yellow. Custom colors are defined in
    # docs/stylesheets/extra.css ([data-md-color-primary="custom"], ...).
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: custom
      accent: custom
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: custom
      accent: custom
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode

extra_css:
  - stylesheets/extra.css

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/HyukjinKwon/pyspark-client-wasm
      name: pyspark-connect-web on GitHub

plugins:
  - search
  # The API reference (docs/api-reference.md) is hand-written for the tiny,
  # stable public surface - no mkdocstrings autodoc, which kept the build
  # fragile (griffe/autorefs version coupling) for little gain here.

markdown_extensions:
  - admonition
  - attr_list
  - def_list
  - footnotes
  - tables
  - toc:
      permalink: true
  - pymdownx.details
  # ```mermaid``` fenced blocks render as diagrams. Material for MkDocs bundles
  # and initializes mermaid.js for this custom fence (no extra plugin needed).
  - 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

nav:
  - Home: index.md
  - Getting started:
      - Installation: installation.md
      - Quickstart: quickstart.md
      - Running locally: running-locally.md
  - Guides:
      - Embedded BI demo: demo.md
      - Connection patterns: connection-patterns.md
      - JupyterLite hosting: jupyterlite-hosting.md
      - Packaging & release: packaging-release.md
  - Reference:
      - Architecture: architecture.md
      - Security: security.md
      - API reference: api-reference.md