mkdocs.yml

site_name: ome-zarr-models
site_url: https://ome-zarr-models-py.readthedocs.io
repo_url: https://github.com/ome-zarr-models/ome-zarr-models-py
repo_name: ome-zarr-models-py
theme:
  name: material
  language: en
  icon:
    repo: fontawesome/brands/github
  features:
    - navigation.tabs
    - navigation.indexes
  palette:
    # Palette toggle for light mode

    - media: "(prefers-color-scheme: light)"
      primary: pink
      scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      primary: pink
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

markdown_extensions:
  - toc:
      toc_depth: 3

plugins:
  - mkdocs-jupyter:
      execute: true
      allow_errors: false
  - mkdocstrings:
      handlers:
        python:
          paths: [src]
          import:
            - https://docs.python.org/3/objects.inv

          options:
            docstring_style: numpy
            show_root_toc_entry: false
            show_object_full_path: true
            group_by_category: true
            heading_level: 3
            show_symbol_type_heading: true
            separate_signature: true
            show_source: false
            show_signature_annotations: true
            signature_crossrefs: true
            extensions:
              - griffe_pydantic:
                  schema: false

nav:
  - Home: index.md
  - Tutorial: tutorial.py
  - API reference:
      - api/index.md
      - v04:
          - api/v04/hcs.md
          - api/v04/image.md
          - api/v04/image-label.md
          - api/v04/labels.md
          - api/v04/well.md
  - Changelog: changelog.md
  - Contributing: contributing.md

watch:
  - src