mkdocs.yml

site_name: Frads
site_description: Building lighting and energy simulation control in Python
strict: true
repo_url: https://github.com/LBNL-ETA/frads/

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
      primary: white

    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
      primary: black
  font:
    text: OpenSans
  features:
    # - navigation.tracking
    # - navigation.tabs
    # - navigation.sections
    # - navigation.indexes
    - content.tabs.link
    - content.code.annotate
    - announce.dismiss
    - navigation.tabs
    - content.code.copy
extra_css: [css/extra.css]
markdown_extensions:
  - admonition
  - attr_list
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - def_list
  - pymdownx.details
  - pymdownx.tabbed:
      alternate_style: true

plugins:
- search
- autorefs
- mkdocstrings:
    default_handler: python
    handlers:
      python:
        options:
          member_order: source
          separate_signature: true
          show_source: false
          show_root_heading: true
          merge_init_into_class: true

nav:
  - Get Started:
    - Welcome to frads: index.md
    - Why frads: why.md
    - Installation: install.md
    # - Usage:
    #   - Phase Methods:
    #     - Two Phase Method: usage/phase/twophase.md
    #     - Three Phase Method: usage/phase/threephase.md
    #     - Five Phase Method: usage/phase/fivephase.md
  - How-To Guides:
    - how-to/index.md
  - CLI Manual:
    - manual/index.md
    - mrad:
      - manual/mrad/index.md
      - mrad init: manual/mrad/init.md
      - mrad run: manual/mrad/run.md
    - gen:
      - manual/gen/index.md
      - glaze: manual/gen/glaze.md
      - grid: manual/gen/grid.md
      - matrix:
        - manual/gen/matrix/index.md
        - point-sky: manual/gen/matrix/point_sky.md
        - view-sky: manual/gen/matrix/view_sky.md
        - surface-sky: manual/gen/matrix/surface_sky.md
        - point-surface: manual/gen/matrix/point_surface.md
        - view-surface: manual/gen/matrix/view_surface.md
        - surface-surface: manual/gen/matrix/surface_surface.md
        - point-sun: manual/gen/matrix/point_sun.md
        - view-sun: manual/gen/matrix/view_sun.md
        - ncp: manual/gen/matrix/ncp.md
      - room: manual/gen/room.md
  - Reference:
    - WorkflowConfig: ref/config.md
    - TwoPhaseMethod: ref/twophase.md
    - ThreePhaseMethod: ref/threephase.md
    - FivePhaseMethod: ref/fivephase.md
    - matrix: ref/matrix.md
    - EnergyPlus: ref/eplus.md
    - GlazingSystem: ref/window.md
    - Sky: ref/sky.md