mkdocs.yml

# Project information
site_name: Tidy Tools User Guide
site_url: https://lucas-nelson-uiuc.github.io/tidy_tools/
repo_url: https://github.com/lucas-nelson-uiuc/tidy_tools
repo_name: tidy_tools

theme:
  name: material
  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
  logo: _assets/logo_small.png
  features:
    - navigation.tracking
    - navigation.instant
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.footer
    - navigation.indexes
    - content.tabs.link
    - content.code.copy
  icon:
    repo: fontawesome/brands/github


nav:
  - User Guide:
    - index.md
    - user-guide/getting-started.md
    - user-guide/installation.md
    - Concepts:
      - user-guide/concepts/declarative.md
    - Modules:
      - user-guide/modules/core.md
      - user-guide/modules/dataframe.md
      - user-guide/modules/models.md
      - user-guide/modules/workflow.md
  - API Documentation:
    - api/api-reference.md
    - Core:
      - api/core/selector.md
      - api/core/filter.md
    - DataFrame:
      - api/dataframe/context.md
      - api/dataframe/dataframe.md
      - api/dataframe/handler.md
    - Functions:
      - api/functions/reader.md
      - api/functions/merge.md
    - Model:
      - api/model/model.md
      - api/model/convert.md
      - api/model/validate.md
    - Workflow:
      - api/workflow/compose.md
      - api/workflow/pipeline.md
  - Development:
    - development/contribution.md

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          paths: [.]
          options:
            members_order: source
            separate_signature: true
            filters: ["!^_"]
            docstring_style: numpy
            docstring_options:
              ignore_init_summary: true
            merge_init_into_class: true
            show_signature_annotations: true
            signature_crossrefs: true


markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences