mkdocs.yml

site_name: dbx
site_description: 🧱Databricks CLI eXtensions - aka dbx is a CLI tool for development and advanced Databricks workflows management.
site_url: https://dbx.readthedocs.io/en/latest/
copyright: © Copyright 2022, Databricks Inc.

theme:
  name: material
  custom_dir: docs/overrides
  font:
    text: DM Sans
    code: DM Mono
  palette:
    - media: '(prefers-color-scheme: light)'
      scheme: default
      primary: black
      accent: indigo
      toggle:
        icon: material/lightbulb
        name: Switch to light mode
    - media: '(prefers-color-scheme: dark)'
      scheme: slate
      primary: black
      accent: indigo
      toggle:
        icon: material/lightbulb-outline
        name: Switch to dark mode
  features:
    - content.code.annotate
    - content.tabs.link
    - search.highlight
    - search.share
    - search.suggest
    - toc.follow
    - navigation.sections
    - navigation.tabs
    - navigation.top
    - navigation.footer
  icon:
    repo: fontawesome/brands/github
  logo: img/logo.svg
  favicon: img/logo.svg
  language: en

repo_name: databrickslabs/dbx
repo_url: https://github.com/databrickslabs/dbx
edit_uri: edit/main/docs

plugins:
  - search
  - glightbox
  - git-revision-date-localized:
      type: timeago
      enable_creation_date: true
      exclude:
        - index.md

extra_css:
  - extras/styles.css

markdown_extensions:
  - attr_list
  - md_in_html
  - toc:
      permalink: "#"
  - pymdownx.emoji:
      emoji_index: !!python/name:materialx.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg
  - admonition
  - pymdownx.details
  - pymdownx.inlinehilite
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.smartsymbols
  - pymdownx.details
  - pymdownx.caret
  - pymdownx.mark
  - pymdownx.tilde
  - pymdownx.betterem:
      smart_enable: all
  - mkdocs-click
  - pymdownx.tasklist:
      custom_checkbox: true

nav:
  - 'index.md'
  - Intro: intro.md
  - Concepts:
      - Place of dbx in the ecosystem: concepts/ecosystem.md
      - DevOps for workflows: concepts/devops.md
      - Testing workflows: concepts/testing.md
      - Cluster types for various flows: concepts/cluster_types.md
      - Artifact storage: concepts/artifact_storage.md
  - Guides:
      - General:
          - Dependency management: guides/general/dependency_management.md
          - Passing parameters: guides/general/passing_parameters.md
          - Delta Live Tables: guides/general/delta_live_tables.md
          - Custom templates: guides/general/custom_templates.md
      - Python:
          - Python quickstart: guides/python/python_quickstart.md
          - Development loop:
              - Mixed-mode development loop for Python projects: guides/python/devloop/mixed.md
              - Development loop for Python package-based projects: guides/python/devloop/package.md
          - DevOps:
              - DevOps for Python package-based projects: guides/python/devops/package.md
              - DevOps for Notebooks-based projects: guides/python/devops/notebook.md
              - DevOps for Mixed-mode projects: guides/python/devops/mixed.md
          - Packaging arbitrary files: guides/python/packaging_files.md
          - Running integration tests: guides/python/integration_tests.md
      - JVM:
          - Development loop for JVM-based projects: guides/jvm/jvm_devloop.md
          - DevOps for JVM-based projects: guides/jvm/jvm_devops.md
  - Features:
      - Assets-based deployment and launch: features/assets.md
      - File references: features/file_references.md
      - Build management: features/build_management.md
      - Jinja support: features/jinja_support.md
      - Named properties: features/named_properties.md
      - Permissions management: features/permissions_management.md
      - Additional headers: features/headers.md
  - Reference:
      - CLI Reference: reference/cli.md
      - Deployment file reference: reference/deployment.md
      - Project file reference: reference/project.md
  - Migration: migration.md
  - Frequently Asked Questions: faq.md