mkdocs.yml

site_name: nd2
site_author: Talley Lambert
repo_name: tlambert03/nd2
repo_url: https://github.com/tlambert03/nd2
edit_uri: edit/main/docs/
site_description: A Python package for reading Nikon ND2 files
copyright: 'Talley Lambert © 2021'
strict: true

watch:
  - src

theme:
  name: material
  icon:
    logo: material/camera-iris
    repo: fontawesome/brands/github
  features:
    - navigation.sections
  palette:
    # Palette toggle for light mode
    - scheme: default
      primary: yellow
      accent: teal
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

    # Palette toggle for dark mode
    - scheme: slate
      primary: black
      accent: yellow
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - tables
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - toc:
      permalink: true

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          options:
            show_bases: false
            show_source: false
            show_root_toc_entry: false
            docstring_style: numpy
            docstring_section_style: list
            show_signature_annotations: true
            signature_crossrefs: true
            filters:
              - "!^__"
              - "!^_"
          import:
            - https://numpy.org/doc/stable/objects.inv
            - https://docs.python.org/3/objects.inv
            - https://docs.xarray.dev/en/stable/objects.inv
            - https://docs.dask.org/en/stable/objects.inv

extra_css:
  - styles/extra.css