Clean up mkdocs config (#388)

mkdocs.yml

@@ -1,69 +1,12 @@
-site_name: Polars User Guide
+# https://www.mkdocs.org/user-guide/configuration/
+
+# Project information
+site_name: Polars documentation
 site_url: https://pola-rs.github.io/polars-book
-theme:
-  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
-  name: material
-  custom_dir: docs/_build/overrides
-  logo: _build/assets/logo.png
-  features:
-    - navigation.tracking
-    - navigation.instant
-    - navigation.tabs
-    - navigation.tabs.sticky
-    - navigation.footer
-    - content.tabs.link
-  icon:
-    repo: fontawesome/brands/github
-plugins:
-  - search:
-      lang: en
-  - markdown-exec
-  - macros:
-      module_name: docs/_build/scripts/macro
-extra:
-  consent:
-    title: Cookie consent
-    description: >-
-      We use cookies to recognize your repeated visits and preferences, as well
-      as to measure the effectiveness of our documentation and whether users
-      find what they're searching for. With your consent, you're helping us to
-      make our documentation better.
-  analytics:
-    provider: google
-    property: G-LKNVFWD3T5
-markdown_extensions:
-  - admonition
-  - pymdownx.details
-  - attr_list
-  - pymdownx.emoji:
-      emoji_index: !!python/name:materialx.emoji.twemoji
-      emoji_generator: !!python/name:materialx.emoji.to_svg
-  - pymdownx.superfences
-  - pymdownx.tabbed:
-      alternate_style: true
-  - pymdownx.snippets:
-      base_path: ['.','docs/src/']
-      check_paths: true
-      dedent_subsections: true
-  - footnotes
-extra_css:
-  - _build/css/extra.css
 repo_url: https://github.com/pola-rs/polars
 repo_name: pola-rs/polars
-watch:
-  - docs/_build/scripts
+
+# Documentation layout
 nav:
   - Home: index.md
   - Getting Started:
@@ -137,6 +80,83 @@ nav:
       - user-guide/misc/alternatives.md
       - user-guide/misc/reference-guides.md
       - user-guide/misc/contributing.md
+not_in_nav: |
+  /_build/
+  people.md
+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/_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
+    - content.tabs.link
+  icon:
+    repo: fontawesome/brands/github
+
+extra_css:
+  - _build/css/extra.css
+extra:
+  consent:
+    title: Cookie consent
+    description: >-
+      We use cookies to recognize your repeated visits and preferences, as well
+      as to measure the effectiveness of our documentation and whether users
+      find what they're searching for. With your consent, you're helping us to
+      make our documentation better.
+  analytics:
+    provider: google
+    property: G-LKNVFWD3T5
+
+# Preview controls
+strict: true
+
+# Formatting options
+markdown_extensions:
+  - admonition
+  - pymdownx.details
+  - attr_list
+  - pymdownx.emoji:
+      emoji_index: !!python/name:materialx.emoji.twemoji
+      emoji_generator: !!python/name:materialx.emoji.to_svg
+  - pymdownx.superfences
+  - pymdownx.tabbed:
+      alternate_style: true
+  - pymdownx.snippets:
+      base_path: ['.','docs/src/']
+      check_paths: true
+      dedent_subsections: true
+  - footnotes
 
 hooks:
   - docs/_build/scripts/people.py
+
+plugins:
+  - search:
+      lang: en
+  - markdown-exec
+  - macros:
+      module_name: docs/_build/scripts/macro