# ---------------------------------------------------------------------------
# NeuroPose documentation site configuration.
#
# Local preview:   uv run mkdocs serve
# Strict build:    uv run mkdocs build --strict   (run by .github/workflows/docs.yml)
#
# The API Reference pages are generated by mkdocstrings from the module
# docstrings; adding a new module means adding a stub file under docs/api/
# and a nav entry below.
# ---------------------------------------------------------------------------

site_name: NeuroPose
site_description: 3D human pose estimation pipeline for clinical movement research.
site_url: https://levineuwirth.github.io/neuropose/
repo_url: https://git.levineuwirth.org/neuwirth/neuropose
repo_name: neuwirth/neuropose
edit_uri: _edit/main/docs/
copyright: Copyright © 2026 The NeuroPose Authors

theme:
  name: material
  features:
    - navigation.tabs
    - navigation.top
    - navigation.tracking
    - content.code.copy
    - content.code.annotate
    - content.action.edit
    - search.suggest
    - search.highlight
    - toc.follow
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/toggle-switch
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/toggle-switch-off-outline
        name: Switch to light mode
  icon:
    repo: fontawesome/brands/git-alt

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          options:
            show_source: true
            show_root_heading: true
            show_root_toc_entry: false
            show_category_heading: true
            show_signature_annotations: true
            separate_signature: true
            docstring_style: numpy
            docstring_section_style: table
            members_order: source
            filters:
              - "!^_"

markdown_extensions:
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - tables
  - toc:
      permalink: true
  - pymdownx.details
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true

nav:
  - Home: index.md
  - Getting Started: getting-started.md
  - Architecture: architecture.md
  - API Reference:
      - neuropose.config: api/config.md
      - neuropose.estimator: api/estimator.md
      - neuropose.interfacer: api/interfacer.md
      - neuropose.ingest: api/ingest.md
      - neuropose.monitor: api/monitor.md
      - neuropose.io: api/io.md
      - neuropose.migrations: api/migrations.md
      - neuropose.benchmark: api/benchmark.md
      - neuropose.analyzer.segment: api/segment.md
      - neuropose.visualize: api/visualize.md
  - Development: development.md
  - Deployment: deployment.md