mkdocs.yml

site_name: Hera Documentation
site_description: Deep technical reference and user guide for the Hera scientific data management platform
site_url: https://KaplanOpenSource.github.io/hera/
repo_url: https://github.com/KaplanOpenSource/hera
repo_name: KaplanOpenSource/hera

theme:
  name: material
  custom_dir: docs/overrides
  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.expand
    - navigation.top
    - navigation.instant
    - navigation.instant.progress
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.code.annotate
  palette:
    - scheme: default
      primary: indigo
      accent: teal
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: indigo
      accent: teal
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  icon:
    repo: fontawesome/brands/github

plugins:
  - search
  - mkdocstrings:
      enabled: true
      default_handler: python
      handlers:
        python:
          paths:
            - .
          options:
            show_source: true
            show_root_heading: true
            heading_level: 3
            docstring_style: numpy
            show_signature_annotations: true
            members_order: source
            allow_inspection: false
  - mkdocs-jupyter:
      include_source: true
      execute: false
      allow_errors: true
      include_requirejs: true

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.tabbed:
      alternate_style: true
  - tables
  - attr_list
  - md_in_html
  - toc:
      permalink: true

extra_css:
  - overrides/stylesheets/mermaid-zoom.css

extra_javascript:
  - overrides/javascripts/mermaid-zoom.js

nav:
  - Home: index.md
  - User Guide:
      - Overview: user_guide/index.md
      - Installation & Setup: user_guide/installation.md
      - Key Concepts: user_guide/concepts.md
      - Projects: user_guide/projects.md
      - Working with Data: user_guide/working_with_data.md
      - CLI Reference: cli/reference.md
      - Toolkits:
          - Understanding Toolkits: toolkits/understanding_toolkits.md
          - Repositories: user_guide/repositories.md
          - Toolkit Catalog: toolkits/overview.md
          - Measurements:
              - GIS:
                  - Topography (Raster): toolkits/measurements/gis/topography_raster.md
                  - Topography (Vector): toolkits/measurements/gis/topography_vector.md
                  - Buildings: toolkits/measurements/gis/buildings.md
                  - Demography: toolkits/measurements/gis/demography.md
                  - Land Cover: toolkits/measurements/gis/landcover.md
                  - Tiles: toolkits/measurements/gis/tiles.md
              - Meteorology:
                  - MeteoLowFreq: toolkits/measurements/meteorology/lowfreq.md
                  - MeteoHighFreq: toolkits/measurements/meteorology/highfreq.md
              - Experiment: toolkits/measurements/experiment.md
          - Simulations:
              - OpenFOAM: toolkits/simulations/openfoam.md
              - LSM: toolkits/simulations/lsm.md
              - Gaussian Dispersion: toolkits/simulations/gaussian.md
              - Wind Profile: toolkits/simulations/windprofile.md
              - Hermes Workflows: toolkits/simulations/workflows.md
          - Risk Assessment: toolkits/risk_assessment.md
      - Utilities: user_guide/utilities/index.md
      - Tutorials: tutorials/index.md
      - Examples:
          - Repository Examples: examples/repository_examples.md
          - Workflows: examples/workflows.md
      - Best Practices: guides/best_practices.md
      - Quick Reference:
          - Cheat Sheet: reference/cheat_sheet.md
          - Environment Variables: configuration/env_vars.md
          - Glossary: glossary.md
      - AI Search: user_guide/ai_search.md
      - Troubleshooting: troubleshooting.md
      - FAQ: faq.md
  - Developer Guide:
      - Overview: developer_guide/index.md
      - Architecture:
          - Core Concepts: architecture/core_concepts.md
          - Data Layer: architecture/data_layer.md
          - Measurements:
              - Overview: developer_guide/measurements/index.md
              - GIS: developer_guide/measurements/gis.md
              - Meteorology: developer_guide/measurements/meteorology.md
              - Experiment: developer_guide/measurements/experiment.md
          - Simulations:
              - Overview: developer_guide/simulations/index.md
              - OpenFOAM: developer_guide/simulations/openfoam.md
              - LSM: developer_guide/simulations/lsm.md
              - Gaussian Dispersion: developer_guide/simulations/gaussian.md
              - Wind Profile: developer_guide/simulations/windprofile.md
              - Hermes Workflows: developer_guide/simulations/workflows.md
              - ML / Deep Learning: developer_guide/simulations/ml.md
          - Risk Assessment: developer_guide/risk_assessment.md
      - RAG Search: developer_guide/rag.md
      - Testing:
          - Getting Started: testing/getting_started.md
          - Test Flow: testing/flow.md
      - API Reference:
          - Overview: developer_guide/api/index.md
          - Core: developer_guide/api/core.md
          - Data Layer: developer_guide/api/datalayer.md
          - Measurements: developer_guide/api/measurements.md
          - Simulations: developer_guide/api/simulations.md
          - Risk Assessment: developer_guide/api/risk.md
          - Utilities: developer_guide/api/utils.md
      - Roadmap: developer_guide/roadmap.md
      - Reference:
          - Repository Schema: reference/repository_schema.md
          - Environment Variables: configuration/env_vars.md