mkdocs.yml

site_name: rgfrosh
site_url: https://vasulab.github.io/rgfrosh
repo_name: VasuLab/rgfrosh
repo_url: https://github.com/VasuLab/rgfrosh
edit_uri: tree/main/docs/

nav:
  - Home:
      - index.md
      - Changelog: changelog.md
      - License: license.md
  - User Guide:
    - Getting Started: guide/getting-started.md
    - Thermodynamic Interfaces: guide/thermodynamic-interfaces.md
  - Reference:
    - reference/index.md
    - Shock Models:
      - reference/shock/index.md
      - Ideal Shock: reference/shock/ideal.md
      - Frozen Shock: reference/shock/frozen.md
    - Thermo: reference/thermo.md
    - Errors: reference/errors.md
    - Constants: reference/constants.md

theme:
  name: material
  font:
    code: Consolas
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: red
      accent: red
      toggle:
        icon: material/toggle-switch-off-outline
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: red
      accent: red
      toggle:
        icon: material/toggle-switch
        name: Switch to light mode
  icon:
    repo: fontawesome/brands/github
  features:
    - content.code.annotate
    - navigation.expand
    - navigation.footer
    - navigation.indexes
    - navigation.tabs
    - toc.follow

plugins:
  - search
  - social
  - mkdocstrings:
      handlers:
        python:
          options:
            docstring_section_style: list
            members_order: source
            merge_init_into_class: true
            show_signature_annotations: true
            show_root_heading: true
            show_root_full_path: false
            show_source: false

markdown_extensions:
  - abbr
  - attr_list
  - admonition
  - footnotes
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.snippets:
      auto_append:
        - includes/abbreviations.md
  - pymdownx.caret
  - pymdownx.highlight
  - pymdownx.inlinehilite
  - pymdownx.superfences
  - pymdownx.snippets
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tilde

watch:
  - rgfrosh

extra:
  generator: false
  version:
    provider: mike

extra_css:
- css/style.css

extra_javascript:
  - javascripts/mathjax.js
  - https://polyfill.io/v3/polyfill.min.js?features=es6
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js