mkdocs.yml

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

repo_url: "https://github.com/datachain-ai/datachain"
repo_name: "datachain-ai/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:
              - Overview: references/func.md
              - Aggregate: references/functions/aggregate.md
              - Array: references/functions/array.md
              - Conditional: references/functions/conditional.md
              - Numeric: references/functions/numeric.md
              - Path: references/functions/path.md
              - Random: references/functions/random.md
              - String: references/functions/string.md
              - Window: references/functions/window.md
          - Toolkit: references/toolkit.md
      - 📖 CLI Reference:
          - Overview: commands/index.md
          - Commands:
              - auth:
                  - login: commands/auth/login.md
                  - logout: commands/auth/logout.md
                  - token: commands/auth/token.md
                  - team: commands/auth/team.md
              - job:
                  - run: commands/job/run.md
                  - logs: commands/job/logs.md
                  - cancel: commands/job/cancel.md
                  - ls: commands/job/ls.md
                  - clusters: commands/job/clusters.md
              - pipeline:
                  - create: commands/pipeline/create.md
                  - status: commands/pipeline/status.md
                  - list: commands/pipeline/list.md
                  - pause: commands/pipeline/pause.md
                  - resume: commands/pipeline/resume.md
                  - remove-job: commands/pipeline/remove-job.md
      - 📚 User Guide:
          - Overview: guide/index.md
          - 📡 Interacting with remote storage: guide/remotes.md
          - Data Processing:
              - Overview: guide/processing.md
              - Delta Processing: guide/delta.md
              - Errors Handling and Retries: guide/retry.md
          - Checkpoints: guide/checkpoints.md
          - Environment Variables: guide/env.md
          - Namespaces: guide/namespaces.md
          - Local DB Migrations: guide/db_migrations.md
      - 🔗 Studio:
          - Overview: studio/index.md
          - User Guide:
              - Overview: studio/user-guide/index.md
              - Account Management: studio/user-guide/account-management.md
              - Jobs:
                  - Overview: studio/user-guide/jobs/index.md
                  - Create and Run: studio/user-guide/jobs/create-and-run.md
                  - Monitor Jobs: studio/user-guide/jobs/monitor-jobs.md
              - Experiments:
                  - Overview: studio/user-guide/experiments/index.md
                  - Create a Project: studio/user-guide/experiments/create-a-project.md
                  - Configure a Project: studio/user-guide/experiments/configure-a-project.md
                  - Run Experiments: studio/user-guide/experiments/run-experiments.md
                  - Explore ML Experiments: studio/user-guide/experiments/explore-ml-experiments.md
                  - Live Metrics and Plots: studio/user-guide/experiments/live-metrics-and-plots.md
                  - Visualize and Compare: studio/user-guide/experiments/visualize-and-compare.md
                  - Share a Project: studio/user-guide/experiments/share-a-project.md
              - Model Registry:
                  - View and Compare Models: studio/user-guide/model-registry/view-and-compare-models.md
                  - Add a Model: studio/user-guide/model-registry/add-a-model.md
                  - Register a Model Version: studio/user-guide/model-registry/register-version.md
                  - Assign Stage to Model Version: studio/user-guide/model-registry/assign-stage.md
                  - Use Models: studio/user-guide/model-registry/use-models.md
                  - Remove a Model, Version, or Stage: studio/user-guide/model-registry/remove-a-model-or-its-details.md
              - Git Connections:
                  - Overview: studio/user-guide/git-connections/index.md
                  - GitHub App: studio/user-guide/git-connections/github-app.md
                  - Custom GitLab Server: studio/user-guide/git-connections/custom-gitlab-server.md
              - Team Collaboration: studio/user-guide/team-collaboration.md
              - Authentication:
                  - Single Sign-on: studio/user-guide/authentication/single-sign-on.md
                  - OpenID Connect: studio/user-guide/authentication/openid-connect.md
              - Troubleshooting: studio/user-guide/troubleshooting.md
          - API: studio/api/index.md
          - Webhooks: studio/webhooks.md
          - Self-hosting:
              - Overview: studio/self-hosting/index.md
              - Installation:
                  - Overview: studio/self-hosting/installation/index.md
                  - AWS AMI: studio/self-hosting/installation/aws-ami.md
                  - Kubernetes (Helm): studio/self-hosting/installation/k8s-helm.md
              - Configuration:
                  - Overview: studio/self-hosting/configuration/index.md
                  - SSL/TLS: studio/self-hosting/configuration/ssl-tls.md
                  - CA Certificates: studio/self-hosting/configuration/ca-certificates.md
                  - Git Forges:
                      - Overview: studio/self-hosting/configuration/git-forges/index.md
                      - GitHub: studio/self-hosting/configuration/git-forges/github.md
                      - GitLab: studio/self-hosting/configuration/git-forges/gitlab.md
                      - Bitbucket: studio/self-hosting/configuration/git-forges/bitbucket.md
              - Upgrading:
                  - Overview: studio/self-hosting/upgrading/index.md
                  - Regular Procedure: studio/self-hosting/upgrading/regular-procedure.md
                  - Airgap Procedure: studio/self-hosting/upgrading/airgap-procedure.md
              - Troubleshooting:
                  - Overview: studio/self-hosting/troubleshooting/index.md
                  - 502 Errors: studio/self-hosting/troubleshooting/502-errors.md
                  - Support Bundle: studio/self-hosting/troubleshooting/support-bundle.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/datachain-ai/datachain
    - icon: fontawesome/brands/twitter
      link: https://twitter.com/DVCorg
    - icon: fontawesome/brands/linkedin
      link: https://www.linkedin.com/company/dvc-ai

hooks:
  - docs/api_hooks.py
plugins:
  - search
  - section-index
  - mkdocstrings:
      handlers:
        python:
          options:
            show_submodules: no
            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
          inventories:
            - 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  # SSL certificate issue
            - https://docs.pydantic.dev/latest/objects.inv

watch:
  - src/datachain