mkdocs.yml

site_name: hmm-studio
site_description: HMM topology editor, constrained fit engine, and visualizer
repo_url: https://github.com/RoJLD/HMMstudio
edit_uri: edit/main/docs/
site_url: https://rojld.github.io/HMMstudio/

docs_dir: docs

theme:
  name: material
  palette:
    - scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.top
    - search.suggest
    - search.highlight
    - content.code.copy

plugins:
  - search
  # social plugin requires cairosvg + pillow system libs; enable once those are
  # installed in the CI image or locally. Uncomment to activate:
  # - social:
  #     cards: true
  #     cards_layout_options:
  #       background_color: "#4f46e5"
  #       color: "#ffffff"

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

extra_javascript:
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js

nav:
  - Home: index.md
  - Getting started: getting-started.md
  - Project:
      - Roadmap: roadmap.md
      - "Sub-project A: hmm-core (shipped)":
          - "Design spec": specs/2026-05-21-hmm-core-design.md
          - "Implementation plan": plans/2026-05-21-hmm-core.md
      - "Sub-project B: web UI (draft)":
          - "Design spec (DRAFT)": specs/2026-05-21-hmm-studio-web-design.md
      - "Sub-project C: advanced viz (draft)":
          - "Design spec (DRAFT)": specs/2026-05-21-hmm-viz-advanced-design.md
      - "Sub-project B.1 plan (backend skeleton)": plans/2026-05-22-b1-backend-skeleton.md
      - "Specs":
          - "Phase V: validation": specs/2026-05-22-phase-v-validation.md
          - "Phase A.10: GMM-NHMM": specs/2026-05-22-phase-a10-gmm-nhmm.md
          - "Phase A.11: HHMM": specs/2026-05-22-phase-a11-hhmm.md
          - "Phase A.13: Factorial NHMM": specs/2026-05-22-phase-a13-factorial-nhmm.md
          - "Phase B.10: Data warehouse": specs/2026-05-22-phase-b10-data-warehouse.md
          - "Phase E: Academy": specs/2026-05-22-phase-e-academy.md
  - Guides:
      - "Data warehouse": guides/data-warehouse.md
      - "Settings": guides/settings.md
      - "GMM-NHMM (multi-modal regimes)": guides/gmm-nhmm.md
      - "Factorial NHMM (multi-factor regimes)": guides/factorial-nhmm.md
      - "Drop-in with scikit-learn": guides/sklearn-integration.md
  - Decisions:
      - "ADR-0001: hmmlearn patch": decisions/0001-backend-hmmlearn-patch.md
      - "ADR-0002: B stack decisions": decisions/0002-b-stack-decisions.md
      - "ADR-0003: backend abstraction": decisions/0003-backend-abstraction.md
      - "ADR-0004: supervised training": decisions/0004-supervised-training.md
      - "ADR-0005: per-state EmissionSpec": decisions/0005-per-state-emissions-scope.md
      - "ADR-0006: Dirichlet priors": decisions/0006-dirichlet-priors-scope.md
      - "ADR-0007: GMM-NHMM": decisions/0007-gmm-nhmm-scope.md
      - "ADR-0010: data warehouse scope": decisions/0010-data-warehouse-scope.md
      - "ADR-0012: distribution strategy (hybrid)": decisions/0012-distribution-strategy-hybrid.md
      - "ADR-0013: JaxBackend scope (gated)": decisions/0013-jax-backend-scope.md
      - "ADR-0014: Student-t emissions (gated)": decisions/0014-student-t-emissions-scope.md
  - Contributing: contributing.md