mkdocs.yml

site_name: psygnal
site_url: https://github.com/pyapp-kit/psygnal
site_author: Talley Lambert
site_description: >-
  Pure python callback/event system modeled after Qt Signals

# Repository
repo_name: pyapp-kit/psygnal
repo_url: https://github.com/pyapp-kit/psygnal

# Copyright
copyright: Copyright © 2021 - 2022 Talley Lambert

extra_css:
  - stylesheets/extra.css

watch:
  - src/psygnal

nav:
  - Overview: index.md
  - Usage: usage.md
  - Evented Dataclasses: dataclasses.md
  - API:
    - Core API: API/index.md
    - Dataclass Descriptor: API/evented.md
    - Evented Pydantic Model: API/model.md
    - Evented Containers: API/containers.md
    - Throttling & Debouncing: API/throttler.md
    - Proxy Objects: API/proxy.md
    - Utilities: API/utilities.md

theme:
  icon:
    logo: material/alarm-light
  name: material
  palette:
    - scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/toggle-switch
        name: Switch to dark mode
    - scheme: slate
      primary: blue grey
      accent: blue grey
      toggle:
        icon: material/toggle-switch-off-outline
        name: Switch to light mode
  features:
    - navigation.instant
    # - navigation.tabs
    # - navigation.top
    # - navigation.tracking
    - search.highlight
    - search.suggest
    # - toc.follow
    # - content.code.annotate
    - content.tabs.link

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.tilde
  - pymdownx.tabbed:
      alternate_style: true
  - toc:
      permalink: "#"

plugins:
  - search
  - autorefs
  - minify:
      minify_html: true
  - mkdocstrings:
      handlers:
        python:
          import:
            - https://docs.python.org/3/objects.inv
          options:
            docstring_style: numpy
            filters: ["!^_"]
            show_root_heading: true
            # show_root_toc_entry: true
            show_root_full_path: true
            # show_object_full_path: false
            # show_root_members_full_path: false
            # show_category_heading: false
            # show_if_no_docstring: false
            # show_signature: true
            # show_signature_annotations: false
            show_source: true
            # show_bases: true
            # group_by_category: true
            # heading_level: 2
            members_order: alphabetical # alphabetical/source

            ## experimental
            # separate_signature: false
            # line_length: 60
            # show_submodules: true
            docstring_section_style: list # or table/list/spacy
  - spellcheck:
      backends: # the backends you want to use
        - codespell: # or nested configs
            dictionaries: [clear, rare]

      # known_words can also be a list of words
      # known_words: known_words.txt