mkdocs.yml

site_name: "pl-matching"
site_description: "Functionality for matching timeseries data."
site_url: "https://pupil-labs.github.io/pl-matching"
repo_url: "https://github.com/pupil-labs/pl-matching"
repo_name: "pupil-labs/pl-matching"
site_dir: "site"
watch: [mkdocs.yml, README.md, CONTRIBUTING.md, src/pupil_labs/matching]
edit_uri: edit/main/docs/

validation:
  omitted_files: warn
  absolute_links: warn
  unrecognized_links: warn

nav:
  - Home:
      - Overview: index.md
      - License: license.md
  - API reference: modules.md
  - Development:
      - Contributing: contributing.md
      - Coverage report: coverage.md

theme:
  name: material
  features:
    - announce.dismiss
    - content.action.edit
    - content.code.copy
    - navigation.indexes
    - navigation.sections
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.top
    - search.highlight
    - search.suggest
    - toc.follow
  palette:
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: teal
      accent: purple
      toggle:
        icon: material/weather-sunny
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: black
      accent: lime
      toggle:
        icon: material/weather-night
        name: Switch to system preference

extra_css:
  - css/material.css
  - css/mkdocstrings.css

markdown_extensions:
  - attr_list
  - admonition
  - callouts
  - footnotes
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.magiclink
  - pymdownx.snippets:
      base_path: [!relative $config_dir]
      check_paths: true
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
      slugify: !!python/object/apply:pymdownx.slugs.slugify
        kwds:
          case: lower
  - pymdownx.tasklist:
      custom_checkbox: true
  - toc:
      permalink: true

plugins:
  - search
  - markdown-exec
  - coverage
  - mkdocstrings:
      handlers:
        python:
          import:
            - https://docs.python.org/3/objects.inv
          paths: [src]
          options:
            docstring_options:
              ignore_init_summary: true
            docstring_section_style: list
            filters: ["!^_"]
            heading_level: 1
            inherited_members: true
            merge_init_into_class: true
            separate_signature: true
            show_root_heading: true
            show_root_full_path: false
            show_signature_annotations: true
            show_source: true
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            signature_crossrefs: true
            summary: true
  - git-revision-date-localized:
      enabled: !ENV [DEPLOY, false]
      enable_creation_date: true
      type: timeago
  - minify:
      minify_html: !ENV [DEPLOY, false]
  - group:
      enabled: !ENV [MATERIAL_INSIDERS, false]
      plugins:
        - typeset

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/pupil-labs
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/pupil_labs_matching/