mkdocs.yml

# Copyright 2026 Columnar Technologies Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

site_name: dbc
site_author: columnar-tech
site_description: dbc is the command line tool for installing and managing ADBC drivers
site_url: https://docs.columnar.tech/dbc
repo_url: https://github.com/columnar-tech/dbc
repo_name: dbc
copyright: Copyright &copy; <a href="https://columnar.tech">2026 Columnar Technologies Inc.</a>
markdown_extensions:
  - admonition
  - def_list
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: false
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
nav:
  - Introduction: index.md
  - Getting Started:
      - getting_started/index.md
      - Installation: getting_started/installation.md
      - First steps: getting_started/first_steps.md
      - FAQ: getting_started/faq.md
      - Cheatsheet: getting_started/cheatsheet.md
  - Guides:
      - guides/index.md
      - Installing Drivers: guides/installing.md
      - Finding Drivers: guides/finding_drivers.md
      - Using a Driver List: guides/driver_list.md
      - Driver Managers: guides/driver_manager.md
      - Python Notebooks: guides/python_notebooks.md
      - Private Drivers: guides/private_drivers.md
  - Concepts:
      - concepts/index.md
      - Driver: concepts/driver.md
      - Driver Manager: concepts/driver_manager.md
      - Driver Manifest: concepts/driver_manifest.md
      - Driver List: concepts/driver_list.md
      - Driver Registry: concepts/driver_registry.md
  - Reference:
      - reference/index.md
      - Commands: reference/cli.md
      - Config Level: reference/config_level.md
      - Driver List: reference/driver_list.md
      - Supported Platforms: reference/supported_platforms.md
      - Analytics: reference/analytics.md
theme:
  name: material
  custom_dir: docs/overrides
  logo: assets/dbc_logo_white_static.svg
  favicon: assets/favicon.ico
  font:
    text: Inter
    code: JetBrains Mono
  palette:
    - media: "(prefers-color-scheme)"
      scheme: slate
      primary: black
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: black
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: black
      toggle:
        icon: material/brightness-4
        name: Switch to system preference
  icon:
    repo: fontawesome/brands/github
  features:
    - content.code.annotate
    - navigation.indexes
    - navigation.instant
    - navigation.path
    - navigation.sections
    - navigation.tracking
    - content.code.copy
    - content.tabs.link
extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/columnar-tech/dbc
    - icon: fontawesome/brands/slack
      link: https://join.slack.com/t/columnar-community/shared_invite/zt-3gt5cb69i-KRjJj~mjUZv5doVmpcVa4w
    - icon: fontawesome/brands/linkedin
      link: http://linkedin.com/company/columnar-tech/
    - icon: fontawesome/brands/x-twitter
      link: https://x.com/columnar_tech
    - icon: fontawesome/brands/bluesky
      link: https://bsky.app/profile/columnar.tech
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/dbc
extra_css:
  - stylesheets/extra.css
exclude_docs: |
  README.md
extra_javascript:
  - scripts/extra.js
plugins:
  - macros:
      module_name: docs/macros
  - privacy
  - search
  - social:
      cards_layout_options:
        logo: docs/assets/icon-512.png
  - llmstxt:
      full_output: llms-full.txt
      markdown_description: |
        dbc simplifies the installation and management of Apache Arrow Database
        Connectivity (ADBC) drivers across multiple platforms including macOS,
        Linux, and Windows. It supports installing pre-built drivers with a
        single command, managing multiple drivers without conflicts, and creating
        reproducible environments with driver list files. dbc works great in
        CI/CD environments and can be installed via pip, Docker, Homebrew, and more.
      sections:
        Getting Started:
          - getting_started/installation.md: Installation instructions for all platforms
          - getting_started/first_steps.md: Getting started with your first driver
          - getting_started/faq.md: Frequently asked questions
        Guides:
          - guides/installing.md: How to install ADBC drivers
          - guides/finding_drivers.md: Discovering available drivers
          - guides/driver_list.md: Using driver lists for reproducible setups
          - guides/driver_manager.md: Working with driver managers
          - guides/python_notebooks.md: Using dbc in Python notebooks
        Concepts:
          - concepts/driver.md: What is an ADBC driver
          - concepts/driver_manager.md: Understanding driver managers
          - concepts/driver_manifest.md: Driver manifest files
          - concepts/driver_list.md: Driver list files for reproducibility
          - concepts/driver_registry.md: Driver registries
        Reference:
          - reference/index.md
          - reference/cli.md: CLI command reference
          - reference/config_level.md: Configuration levels
          - reference/driver_list.md: Driver list file format
          - reference/supported_platforms.md: Supported platforms
          - reference/analytics.md: Analytics and telemetry