mkdocs.yml

site_name: 'DataChain'
site_url: https://docs.datachain.ai
site_description: Wrangle unstructured AI data at scale

repo_url: "https://github.com/iterative/datachain"
repo_name: "iterative/datachain"
edit_uri: edit/main/docs/

strict: true

validation:
  omitted_files: warn
  absolute_links: warn
  unrecognized_links: warn

theme:
  name: material
  custom_dir: docs/overrides
  logo: assets/datachain.svg
  favicon: assets/datachain.svg
  icon:
    repo: fontawesome/brands/github
  features:
    - navigation.instant
    - navigation.instant.progress
    - navigation.tracking
    - navigation.tabs
    - navigation.path
    - navigation.top
    - navigation.footer
    - toc.follow
    - content.action.edit
    - content.code.copy
    - content.code.annotate
    - content.tabs.link
    - content.tooltips
    - search.highlight
    - search.suggest

  palette:
    # Palette toggle for automatic mode
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode

    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/weather-sunny
        name: Switch to dark mode

    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: teal
      accent: teal
      toggle:
        icon: material/weather-night
        name: Switch to system preference

nav:
  - Home:
      - 🔗 Welcome to DataChain: index.md
      - 🏃🏼‍♂️ Quick Start: quick-start.md
      - 🎯 Examples: examples.md
      - 📚 Tutorials: tutorials.md
      - 🐍 API Reference:
          - Overview: references/index.md
          - DataChain: references/datachain.md
          - Data Types:
              - Overview: references/data-types/index.md
              - File: references/data-types/file.md
              - TextFile: references/data-types/textfile.md
              - ImageFile: references/data-types/imagefile.md
              - VideoFile: references/data-types/videofile.md
              - TarVFile: references/data-types/tarvfile.md
              - ArrowRow: references/data-types/arrowrow.md
              - BBox: references/data-types/bbox.md
              - Pose: references/data-types/pose.md
              - Segment: references/data-types/segment.md
          - UDF: references/udf.md
          - Torch: references/torch.md
          - Functions: references/func.md
          - Toolkit: references/toolkit.md
      - 📡 Interacting with remote storage: references/remotes.md
      - 🤝 Contributing: contributing.md

  - DataChain Website ↗: https://datachain.ai" target="_blank"
  - Studio ↗: https://studio.datachain.ai" target="_blank"

markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - pymdownx.details
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences:
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.critic
  - pymdownx.caret
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.tilde
  - tables
  - toc:
      permalink: ''

# Custom permalink style: https://github.com/squidfunk/mkdocs-material/discussions/3535
extra_css:
  - css/github-permalink-style.css

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/iterative/datachain
    - icon: fontawesome/brands/twitter
      link: https://twitter.com/DVCorg
    - icon: fontawesome/brands/linkedin
      link: https://www.linkedin.com/company/dvc-ai

plugins:
  - search
  - section-index
  - mkdocstrings:
      handlers:
        python:
          rendering:
            show_submodules: no
          options:
            docstring_options:
              ignore_init_summary: true
            docstring_section_style: list
            merge_init_into_class: true
            separate_signature: true
            show_root_full_path: false
            show_root_heading: true
            show_signature_annotations: true
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            signature_crossrefs: true
          import:
            - https://docs.python.org/3/objects.inv
            - https://numpy.org/doc/stable/objects.inv
            - https://pandas.pydata.org/docs/objects.inv
            - https://arrow.apache.org/docs/objects.inv
            - https://docs.sqlalchemy.org/objects.inv
            - https://docs.pydantic.dev/latest/objects.inv

watch:
  - src/datachain