-
-
Notifications
You must be signed in to change notification settings - Fork 2k
/
mkdocs.yml
195 lines (182 loc) · 5.68 KB
/
mkdocs.yml
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
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
# https://www.mkdocs.org/user-guide/configuration/
# Project information
site_name: Polars user guide
site_url: https://docs.pola.rs/
repo_url: https://github.com/pola-rs/polars
repo_name: pola-rs/polars
docs_dir: docs/source
# Documentation layout
nav:
- User guide:
- index.md
- user-guide/getting-started.md
- user-guide/installation.md
- Concepts:
- user-guide/concepts/index.md
- user-guide/concepts/data-types-and-structures.md
- user-guide/concepts/expressions-and-contexts.md
- user-guide/concepts/lazy-api.md
- Expressions:
- user-guide/expressions/index.md
- user-guide/expressions/basic-operations.md
- user-guide/expressions/expression-expansion.md
- user-guide/expressions/casting.md
- user-guide/expressions/strings.md
- user-guide/expressions/lists-and-arrays.md
- user-guide/expressions/categorical-data-and-enums.md
- user-guide/expressions/structs.md
- user-guide/expressions/missing-data.md
- user-guide/expressions/aggregation.md
- user-guide/expressions/window-functions.md
- user-guide/expressions/folds.md
- user-guide/expressions/user-defined-python-functions.md
- user-guide/expressions/numpy-functions.md
- Transformations:
- user-guide/transformations/index.md
- user-guide/transformations/joins.md
- user-guide/transformations/concatenation.md
- user-guide/transformations/pivot.md
- user-guide/transformations/unpivot.md
- Time series:
- user-guide/transformations/time-series/parsing.md
- user-guide/transformations/time-series/filter.md
- user-guide/transformations/time-series/rolling.md
- user-guide/transformations/time-series/resampling.md
- user-guide/transformations/time-series/timezones.md
- Lazy API:
- user-guide/lazy/index.md
- user-guide/lazy/using.md
- user-guide/lazy/optimizations.md
- user-guide/lazy/schemas.md
- user-guide/lazy/query-plan.md
- user-guide/lazy/execution.md
- user-guide/lazy/streaming.md
- user-guide/lazy/gpu.md
- IO:
- user-guide/io/index.md
- user-guide/io/csv.md
- user-guide/io/excel.md
- user-guide/io/parquet.md
- user-guide/io/json.md
- user-guide/io/multiple.md
- user-guide/io/hive.md
- user-guide/io/database.md
- user-guide/io/cloud-storage.md
- user-guide/io/bigquery.md
- user-guide/io/hugging-face.md
- Plugins:
- user-guide/plugins/index.md
- SQL:
- user-guide/sql/intro.md
- user-guide/sql/show.md
- user-guide/sql/select.md
- user-guide/sql/create.md
- user-guide/sql/cte.md
- Migrating:
- user-guide/migration/pandas.md
- user-guide/migration/spark.md
- user-guide/ecosystem.md
- Misc:
- user-guide/misc/multiprocessing.md
- user-guide/misc/visualization.md
- user-guide/misc/styling.md
- user-guide/misc/comparison.md
- user-guide/misc/arrow.md
- user-guide/gpu-support.md
- API reference: api/index.md
- Development:
- Contributing:
- development/contributing/index.md
- development/contributing/ide.md
- development/contributing/test.md
- development/contributing/ci.md
- development/contributing/code-style.md
- development/versioning.md
- Releases:
- releases/changelog.md
- Upgrade guides:
- releases/upgrade/index.md
- releases/upgrade/1.md
- releases/upgrade/0.20.md
- releases/upgrade/0.19.md
not_in_nav: |
/_build/
validation:
links:
# Allow an absolute link to the features page for our code snippets
absolute_links: ignore
# Build directories
theme:
name: material
locale: en
custom_dir: docs/source/_build/overrides
palette:
# Palette toggle for light mode
- media: "(prefers-color-scheme: light)"
scheme: default
toggle:
icon: material/brightness-7
name: Switch to dark mode
# Palette toggle for dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
toggle:
icon: material/brightness-4
name: Switch to light mode
logo: _build/assets/logo.png
features:
- navigation.tracking
- navigation.instant
- navigation.tabs
- navigation.tabs.sticky
- navigation.footer
- navigation.indexes
- content.tabs.link
- content.code.copy
icon:
repo: fontawesome/brands/github
extra_javascript:
- _build/js/mathjax.js
- https://unpkg.com/mathjax@3/es5/tex-mml-chtml.js
extra_css:
- _build/css/extra.css
extra:
analytics:
provider: plausible
domain: guide.pola.rs,combined.pola.rs
# Preview controls
strict: true
# Formatting options
markdown_extensions:
- admonition
- pymdownx.details
- attr_list
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
- pymdownx.superfences
- pymdownx.tabbed:
alternate_style: true
- pymdownx.snippets:
base_path: ['.','docs/source/src/']
check_paths: true
dedent_subsections: true
- footnotes
- pymdownx.arithmatex:
generic: true
hooks:
- docs/source/_build/scripts/people.py
plugins:
- search:
lang: en
- markdown-exec
- material-plausible
- macros:
module_name: docs/source/_build/scripts/macro
- redirects:
redirect_maps:
'user-guide/index.md': 'index.md'
'user-guide/basics/index.md': 'user-guide/getting-started.md'
'user-guide/basics/reading-writing.md': 'user-guide/getting-started.md'
'user-guide/basics/expressions.md': 'user-guide/getting-started.md'
'user-guide/basics/joins.md': 'user-guide/getting-started.md'