spark-structured-streaming-internals/mkdocs.yml at main · japila-books/spark-structured-streaming-internals · 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
158
site_name: The Internals of Spark Structured Streaming
site_url: https://books.japila.pl/spark-structured-streaming-internals
site_author: Jacek Laskowski
site_description: Demystifying inner-workings of Spark Structured Streaming

repo_name: Github
repo_url: https://github.com/japila-books/spark-structured-streaming-internals
edit_uri: edit/main/docs/

copyright: Copyright &copy; 2026 Jacek Laskowski

theme:
  name: material
  language: en
  icon:
    logo: material/book-open-page-variant
    repo: material/github
  features:
    # https://squidfunk.github.io/mkdocs-material/reference/code-blocks/#adding-annotations
    - content.code.annotate
    # https://squidfunk.github.io/mkdocs-material/upgrade/#contentcodecopy
    - content.code.copy
    # https://squidfunk.github.io/mkdocs-material/reference/content-tabs/#linked-content-tabs
    - content.tabs.link
    - content.tooltips
    - navigation.indexes
    - navigation.instant
    # https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#navigation-path
    - navigation.path
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.top
    - navigation.tracking
    - search.highlight
    - search.share
    - search.suggest
    - toc.follow
  palette:
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to system preference

markdown_extensions:
  - admonition
  - attr_list
  - footnotes
  - md_in_html
  - toc:
      permalink: true
  - pymdownx.arithmatex
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.critic
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.inlinehilite
  - pymdownx.magiclink
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.superfences
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tilde

plugins:
  # https://lukasgeiter.github.io/mkdocs-awesome-nav/migration-v3/
  - awesome-nav
  - macros
  # https://squidfunk.github.io/mkdocs-material/reference/#built-in-meta-plugin
  - meta
  - minify:
      minify_html: true
  - search
  # https://squidfunk.github.io/mkdocs-material/setup/setting-up-tags/
  - tags:
      enabled: !ENV [CI, false]
      tags_extra_files:
        developer-api.md:
          - DeveloperApi
  # https://squidfunk.github.io/mkdocs-material/reference/#built-in-typeset-plugin
  - typeset

extra:
  analytics:
    provider: google
    property: !ENV GOOGLE_ANALYTICS_KEY
  book:
    title: Spark Structured Streaming
    spark_core: https://books.japila.pl/apache-spark-internals
    spark_sql: https://books.japila.pl/spark-sql-internals
  hadoop:
    # https://github.com/apache/spark/blob/v4.1.1/pom.xml#L130
    version: 3.4.2
    docs: https://hadoop.apache.org/docs/r3.4.2
    api: https://hadoop.apache.org/docs/r3.4.2/api
  java:
    # https://github.com/apache/spark/blob/v4.1.1/pom.xml#L120
    version: 17
    api: https://docs.oracle.com/en/java/javase/17/docs/api/java.base
    spec: https://docs.oracle.com/javase/specs/jls/se17/html
  kafka:
    # https://github.com/apache/spark/blob/v4.1.1/pom.xml#L141
    version: 3.9.1
    api: https://kafka.apache.org/39/javadoc
  rocksdb:
    # https://github.com/apache/spark/blob/v4.1.1/pom.xml#L765-L769
    version: 9.8.4
    api: https://javadoc.io/static/org.rocksdb/rocksdbjni/9.8.4
  scala:
    # https://github.com/apache/spark/blob/v4.1.1/pom.xml#L176
    version: 2.13.18
    binary_version: 2.13
    api: https://www.scala-lang.org/api/2.13.18
    docs: https://docs.scala-lang.org/
    spec: https://www.scala-lang.org/files/archive/spec/2.13
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/jaceklaskowski
    - icon: fontawesome/brands/bluesky
      link: https://bsky.app/profile/books.japila.pl
    - icon: fontawesome/brands/twitter
      link: https://twitter.com/jaceklaskowski
    - icon: fontawesome/brands/linkedin
      link: https://linkedin.com/in/jaceklaskowski
    - icon: fontawesome/brands/medium
      link: https://jaceklaskowski.medium.com
    - icon: fontawesome/brands/mastodon
      link: https://fosstodon.org/@jaceklaskowski
  spark:
    version: 4.2.0-preview2
    commit: https://github.com/apache/spark/commit
    docs: https://spark.apache.org/docs/4.2.0-preview2
    github: https://github.com/apache/spark/blob/v4.2.0-preview2
    jira: https://issues.apache.org/jira/browse

validation:
  omitted_files: warn
  absolute_links: warn
  unrecognized_links: warn

# nav section is in the separate file ".nav.yml" managed by Awesome Nav for MkDocs plugin
# https://lukasgeiter.github.io/mkdocs-awesome-nav/features/nav/