site_name: ATR Data Generator
site_dir: public

theme:
  name: material

  font:
    text: Roboto
    code: Roboto Mono

  features:
  - navigation.top
  - navigation.tracking
  - navigation.indexes

  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
- autorefs
- mkdocstrings:
    handlers:
      python:
        import: # enable auto refs to the doc
        - https://docs.python.org/3/objects.inv
        options:
          show_root_toc_entry: false
          show_object_full_path: false
          show_root_heading: yes
          show_source: true
          docstring_style: google
          merge_init_into_class: yes
          show_category_heading: yes
          separate_signature: yes
          members_order: source

nav:
  - Home: index.md
  - Dataset extraction:
    - extract/index.md
    - Configuration: extract/configuration.md
  - Dataset split:
    - split/index.md
    - Configuration: split/configuration.md
  - Python Reference:
    - Common Arguments: ref/arguments.md
    - Dataset extraction:
      - Arguments: ref/extract/arguments.md
    - Dataset splitting:
      - Arguments: ref/split/arguments.md
  - Development: dev.md

markdown_extensions:
    - smarty
    - toc:
        permalink: True
    - pymdownx.highlight
    - admonition # syntax coloration in code blocks
    - codehilite
    - pymdownx.details

copyright:  Copyright © Teklia

extra:
  social:
    - icon: fontawesome/regular/heart
      name: Teklia official website
      link: https://teklia.com
    - icon: fontawesome/brands/gitlab
      name: Git repository for this project
      link: https://gitlab.com/teklia/workers/base-worker
    - icon: fontawesome/brands/linkedin
      name: Teklia @ LinkedIn
      link: https://www.linkedin.com/company/teklia