Book a Demo!
CoCalc Logo Icon
StoreFeaturesDocsShareSupportNewsAboutPoliciesSign UpSign In
pola-rs
GitHub Repository: pola-rs/polars
 Path: blob/main/mkdocs.yml
6924 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
                - user-guide/ecosystem.md

89
                - Misc:

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
                - releases/changelog.md

109
                - Upgrade guides:

110
                      - releases/upgrade/index.md

111
                      - releases/upgrade/1.md

112
                      - releases/upgrade/0.20.md

113
                      - releases/upgrade/0.19.md

114
    - Polars Cloud:

115
          - polars-cloud/index.md

116
          - polars-cloud/quickstart.md

117
          - polars-cloud/connect-cloud.md

118


119
          - Queries:

120
                - polars-cloud/run/first-query.md

121
                - polars-cloud/run/example-workflow.md

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

123
          - Context:

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

125
                - polars-cloud/context/plugins.md

126
          - Organizations:

127
                - polars-cloud/organization/organizations.md

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

129
                - polars-cloud/organization/billing.md

130
                - polars-cloud/organization/members.md

131
          - Workspaces:

132
                - polars-cloud/workspace/settings.md

133
                - polars-cloud/workspace/team.md

134
          - Authentication:

135
                - polars-cloud/explain/authentication.md

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

137
          - Providers:

138
                - AWS:

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

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

141
          # - Integrations:

142
          # - polars-cloud/integrations/airflow.md

143
          - Misc:

144
                - polars-cloud/cli.md

145
                - polars-cloud/faq.md

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

147
                - polars-cloud/release-notes.md

148
not_in_nav: |

149
    /_build/

150
validation:

151
    links:

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

153
        absolute_links: ignore

154


155
# Build directories

156
theme:

157
    name: material

158
    locale: en

159
    custom_dir: docs/source/_build/overrides

160
    palette:

161
        # Palette toggle for light mode

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

163
          scheme: default

164
          primary: custom

165
          toggle:

166
              icon: material/brightness-7

167
              name: Switch to dark mode

168
        # Palette toggle for dark mode

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

170
          scheme: slate

171
          primary: custom

172
          toggle:

173
              icon: material/brightness-4

174
              name: Switch to light mode

175
    logo: _build/assets/logo.png

176
    features:

177
        - navigation.tracking

178
        - navigation.sections

179
        - navigation.instant

180
        - navigation.tabs

181
        - navigation.tabs.sticky

182
        - navigation.footer

183
        - navigation.indexes

184
        - content.tabs.link

185
        - content.code.copy

186
    icon:

187
        repo: fontawesome/brands/github

188


189
extra_javascript:

190
    - _build/js/mathjax.js

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

192
extra_css:

193
    - _build/css/extra.css

194
extra:

195
    analytics:

196
        provider: plausible

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

198


199
# Preview controls

200
strict: true

201


202
# Formatting options

203
markdown_extensions:

204
    - admonition

205
    - md_in_html

206
    - pymdownx.details

207
    - attr_list

208
    - pymdownx.emoji:

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

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

211
    - pymdownx.superfences

212
    - pymdownx.tabbed:

213
          alternate_style: true

214
    - pymdownx.snippets:

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

216
          check_paths: true

217
          dedent_subsections: true

218
    - footnotes

219
    - pymdownx.arithmatex:

220
          generic: true

221


222
hooks:

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

224


225
plugins:

226
    - search:

227
          lang: en

228
    - markdown-exec

229
    - material-plausible

230
    - macros:

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

232
    - redirects:

233
          redirect_maps:

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

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

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

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

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

239


240