mkdocs.yml

# Ultralytics HUB-SDK 🚀, AGPL-3.0 license

# Configuration file for building the Ultralytics HUB-SDK documentation site using MkDocs.
# Provides settings to control site metadata, customize the appearance using the
# Material theme, define the navigation structure, and enable various plugins.

# Site metadata
site_name: "Ultralytics HUB-SDK Docs"
site_url: "https://ultralytics.github.io/hub-sdk/"
theme:
  logo: https://raw.githubusercontent.com/ultralytics/assets/main/logo/Ultralytics_Logotype_Reverse.svg
  favicon: https://raw.githubusercontent.com/ultralytics/assets/refs/heads/main/logo/favicon-yolo.png
  name: "material"
  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.indexes
    - toc.follow
    - toc.integrate
  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

plugins:
  - search
  - mkdocstrings:
      enabled: true
      default_handler: python
      handlers:
        python:
          options:
            docstring_style: google
            show_root_heading: true
            show_source: true
  - ultralytics:
      add_desc: False
      add_image: True
      add_authors: True
      add_share_buttons: True
      default_image: https://github.com/ultralytics/assets/blob/main/yolov8/banner-yolov8.png

# Validation settings https://www.mkdocs.org/user-guide/configuration/#validation
validation:
  nav:
    omitted_files: info
    not_found: warn
    absolute_links: info
  links:
    absolute_links: relative_to_docs
    anchors: warn
    unrecognized_links: warn

nav:
  - Home: index.md
  - Quickstart: quickstart.md
  - Model: model.md
  - Dataset: dataset.md
  - Project: project.md
  - Reference:
      - base:
          - api_client: reference/base/api_client.md
          - auth: reference/base/auth.md
          - crud_client: reference/base/crud_client.md
          - paginated_list: reference/base/paginated_list.md
          - server_clients: reference/base/server_clients.md
      - helpers:
          - error_handler: reference/helpers/error_handler.md
          - exceptions: reference/helpers/exceptions.md
          - logger: reference/helpers/logger.md
          - utils: reference/helpers/utils.md
      - hub_client: reference/hub_client.md
      - modules:
          - datasets: reference/modules/datasets.md
          - models: reference/modules/models.md
          - projects: reference/modules/projects.md
          - teams: reference/modules/teams.md
          - users: reference/modules/users.md