Book a Demo!
CoCalc Logo Icon
StoreFeaturesDocsShareSupportNewsAboutPoliciesSign UpSign In
pola-rs
GitHub Repository: pola-rs/polars
 Path: blob/main/mkdocs.yml
8353 views
1
# https://www.mkdocs.org/user-guide/configuration/

2


3
# Project information

4
site_name: Polars user guide

5
site_url: https://docs.pola.rs/

6
repo_url: https://github.com/pola-rs/polars

7
repo_name: pola-rs/polars

8


9
docs_dir: docs/source

10


11
# Documentation layout

12
nav:

13
  - Polars:

14
    - User guide:

15
      - index.md

16
      - user-guide/getting-started.md

17
      - user-guide/installation.md

18
      - Concepts:

19
        - user-guide/concepts/index.md

20
        - user-guide/concepts/data-types-and-structures.md

21
        - user-guide/concepts/expressions-and-contexts.md

22
        - user-guide/concepts/lazy-api.md

23
        - user-guide/concepts/streaming.md

24
      - Expressions:

25
        - user-guide/expressions/index.md

26
        - user-guide/expressions/basic-operations.md

27
        - user-guide/expressions/expression-expansion.md

28
        - user-guide/expressions/casting.md

29
        - user-guide/expressions/strings.md

30
        - user-guide/expressions/lists-and-arrays.md

31
        - user-guide/expressions/categorical-data-and-enums.md

32
        - user-guide/expressions/structs.md

33
        - user-guide/expressions/missing-data.md

34
        - user-guide/expressions/aggregation.md

35
        - user-guide/expressions/window-functions.md

36
        - user-guide/expressions/folds.md

37
        - user-guide/expressions/user-defined-python-functions.md

38
        - user-guide/expressions/numpy-functions.md

39
      - Transformations:

40
        - user-guide/transformations/index.md

41
        - user-guide/transformations/joins.md

42
        - user-guide/transformations/concatenation.md

43
        - user-guide/transformations/pivot.md

44
        - user-guide/transformations/unpivot.md

45
        - Time series:

46
          - user-guide/transformations/time-series/parsing.md

47
          - user-guide/transformations/time-series/filter.md

48
          - user-guide/transformations/time-series/rolling.md

49
          - user-guide/transformations/time-series/resampling.md

50
          - user-guide/transformations/time-series/timezones.md

51
      - Lazy API:

52
        - user-guide/lazy/index.md

53
        - user-guide/lazy/using.md

54
        - user-guide/lazy/optimizations.md

55
        - user-guide/lazy/schemas.md

56
        - user-guide/lazy/datatype_exprs.md

57
        - user-guide/lazy/query-plan.md

58
        - user-guide/lazy/execution.md

59
        - user-guide/lazy/sources_sinks.md

60
        - user-guide/lazy/multiplexing.md

61
        - user-guide/lazy/gpu.md

62
      - IO:

63
        - user-guide/io/index.md

64
        - user-guide/io/csv.md

65
        - user-guide/io/excel.md

66
        - user-guide/io/parquet.md

67
        - user-guide/io/json.md

68
        - user-guide/io/multiple.md

69
        - user-guide/io/hive.md

70
        - user-guide/io/database.md

71
        - user-guide/io/cloud-storage.md

72
        - user-guide/io/bigquery.md

73
        - user-guide/io/hugging-face.md

74
        - user-guide/io/sheets_colab.md

75
      - Plugins:

76
        - user-guide/plugins/index.md

77
        - user-guide/plugins/expr_plugins.md

78
        - user-guide/plugins/io_plugins.md

79
      - SQL:

80
        - user-guide/sql/intro.md

81
        - user-guide/sql/show.md

82
        - user-guide/sql/select.md

83
        - user-guide/sql/create.md

84
        - user-guide/sql/cte.md

85
      - Migrating:

86
        - user-guide/migration/pandas.md

87
        - user-guide/migration/spark.md

88
      - Misc:

89
        - user-guide/ecosystem.md

90
        - user-guide/misc/multiprocessing.md

91
        - user-guide/misc/visualization.md

92
        - user-guide/misc/styling.md

93
        - user-guide/misc/comparison.md

94
        - user-guide/misc/arrow.md

95
        - user-guide/misc/polars_llms.md

96
      - user-guide/gpu-support.md

97
    - API:

98
      - api/reference.md

99
    - Development:

100
      - Contributing:

101
        - development/contributing/index.md

102
        - development/contributing/ide.md

103
        - development/contributing/test.md

104
        - development/contributing/ci.md

105
        - development/contributing/code-style.md

106
      - development/versioning.md

107
    - Releases:

108
      - Upgrade guides:

109
        - releases/upgrade/index.md

110
        - releases/upgrade/1.md

111
        - releases/upgrade/0.20.md

112
        - releases/upgrade/0.19.md

113
      - releases/changelog.md

114
  - Polars Cloud:

115
    - polars-cloud/index.md

116
    - polars-cloud/quickstart.md

117
    - polars-cloud/connect-cloud.md

118
    - Queries:

119
      - polars-cloud/run/remote-query.md

120
      - polars-cloud/run/distributed-engine.md

121
      - polars-cloud/run/query-profile.md

122
    - Integrations:

123
      - Orchestration:

124
        - polars-cloud/integrations/index.md

125
        - polars-cloud/integrations/airflow.md

126
        - polars-cloud/integrations/dagster.md

127
        - polars-cloud/integrations/prefect.md

128
        - polars-cloud/integrations/lambda.md

129
    - Concepts:

130
      - Context:

131
        - polars-cloud/context/compute-context.md

132
        - polars-cloud/context/reconnect.md

133
        - polars-cloud/context/plugins.md

134
        - polars-cloud/context/proxy-mode.md

135
      - Organizations:

136
        - polars-cloud/organization/organizations.md

137
        - polars-cloud/organization/start-trial.md

138
        - polars-cloud/organization/billing.md

139
        - polars-cloud/organization/members.md

140
      - Workspaces:

141
        - polars-cloud/workspace/settings.md

142
        - polars-cloud/workspace/team.md

143
      - Authentication:

144
        - polars-cloud/explain/authentication.md

145
        - polars-cloud/explain/service-accounts.md

146
      - Providers:

147
        - AWS:

148
          - polars-cloud/providers/aws/infra.md

149
          - polars-cloud/providers/aws/permissions.md

150
      - Misc:

151
        - polars-cloud/cli.md

152
        - polars-cloud/public-datasets.md

153
        - polars-cloud/faq.md

154
        - API Reference: https://docs.cloud.pola.rs

155
    - API:

156
      - Reference guide: https://docs.cloud.pola.rs/

157
  - Polars on-premises:

158
      - polars-on-premises/index.md

159
      - Kubernetes:

160
        - polars-on-premises/kubernetes/getting-started.md

161
      - Bare-metal:

162
        - polars-on-premises/bare-metal/getting-started.md

163
        - Configuration:

164
          - polars-on-premises/bare-metal/configuration/reference.md

165
          - polars-on-premises/bare-metal/configuration/license.md

166
          - polars-on-premises/bare-metal/configuration/monitoring.md

167
          - polars-on-premises/bare-metal/configuration/resource-limits.md

168
          - polars-on-premises/bare-metal/configuration/shuffle-data.md

169
          - polars-on-premises/bare-metal/configuration/anonymous-results.md

170
          - polars-on-premises/bare-metal/configuration/network-addresses.md

171
          - polars-on-premises/bare-metal/configuration/static-leader.md

172
          - polars-on-premises/bare-metal/configuration/example-configurations.md

173
        - polars-on-premises/bare-metal/environment-variables.md

174
        - polars-on-premises/bare-metal/python-environment.md

175
not_in_nav: |

176
    /_build/

177
validation:

178
    links:

179
        # Allow an absolute link to the features page for our code snippets

180
        absolute_links: ignore

181


182
# Build directories

183
theme:

184
    name: material

185
    locale: en

186
    custom_dir: docs/source/_build/overrides

187
    palette:

188
        # Palette toggle for light mode

189
        - media: "(prefers-color-scheme: light)"

190
          scheme: default

191
          primary: custom

192
          toggle:

193
              icon: material/brightness-7

194
              name: Switch to dark mode

195
        # Palette toggle for dark mode

196
        - media: "(prefers-color-scheme: dark)"

197
          scheme: slate

198
          primary: custom

199
          toggle:

200
              icon: material/brightness-4

201
              name: Switch to light mode

202
    logo: _build/assets/logo.png

203
    features:

204
        - navigation.tracking

205
        - navigation.sections

206
        - navigation.instant

207
        - navigation.tabs

208
        - navigation.tabs.sticky

209
        - navigation.footer

210
        - navigation.indexes

211
        - content.tabs.link

212
        - content.code.copy

213
    icon:

214
        repo: fontawesome/brands/github

215


216
extra_javascript:

217
    - _build/js/mathjax.js

218
    - https://unpkg.com/mathjax@3/es5/tex-mml-chtml.js

219
extra_css:

220
    - _build/css/extra.css

221
extra:

222
    analytics:

223
        provider: plausible

224
        domain: guide.pola.rs,combined.pola.rs

225


226
# Preview controls

227
strict: true

228


229
# Formatting options

230
markdown_extensions:

231
    - admonition

232
    - md_in_html

233
    - pymdownx.details

234
    - attr_list

235
    - pymdownx.emoji:

236
          emoji_index: !!python/name:material.extensions.emoji.twemoji

237
          emoji_generator: !!python/name:material.extensions.emoji.to_svg

238
    - pymdownx.superfences

239
    - pymdownx.tabbed:

240
          alternate_style: true

241
    - pymdownx.snippets:

242
          base_path: [".", "docs/source/src/"]

243
          check_paths: true

244
          dedent_subsections: true

245
    - footnotes

246
    - pymdownx.arithmatex:

247
          generic: true

248


249
hooks:

250
    - docs/source/_build/scripts/people.py

251


252
plugins:

253
    - search:

254
          lang: en

255
    - markdown-exec

256
    - material-plausible

257
    - macros:

258
          module_name: docs/source/_build/scripts/macro

259
    - redirects:

260
          redirect_maps:

261
              "user-guide/index.md": "index.md"

262
              "user-guide/basics/index.md": "user-guide/getting-started.md"

263
              "user-guide/basics/reading-writing.md": "user-guide/getting-started.md"

264
              "user-guide/basics/expressions.md": "user-guide/getting-started.md"

265
              "user-guide/basics/joins.md": "user-guide/getting-started.md"

266
              # rename polars-on-premise to polars-on-premises

267
              "polars-on-premise/index.md": "polars-on-premises/index.md"

268
              "polars-on-premise/bare-metal/getting-started.md": "polars-on-premises/bare-metal/getting-started.md"

269
              "polars-on-premise/kubernetes/getting-started.md": "polars-on-premises/kubernetes/getting-started.md"

270
              "polars-on-premise/bare-metal/config-reference.md": "polars-on-premises/bare-metal/configuration/reference.md"

271
              "polars-on-premise/bare-metal/environment-variables.md": "polars-on-premises/bare-metal/environment-variables.md"

272
              "polars-on-premise/bare-metal/python-environment.md": "polars-on-premises/bare-metal/python-environment.md"

273
              "polars-on-premises/bare-metal/config-reference.md": "polars-on-premises/bare-metal/configuration/reference.md"

274


275


276