mkdocs.yml

# https://www.mkdocs.org/user-guide/configuration/

# Project information
site_name: hpc-multibench
site_author: Edmund Goodman
copyright: Copyright &copy Edmund Goodman

# Repository
repo_name: EdmundGoodman/hpc-multibench
repo_url: https://github.com/EdmundGoodman/hpc-multibench

# Configuration
use_directory_urls: false

nav:
  - Home: index.md
  - Quick start: quickstart.md
  - Manual: manual.md
  - YAML schema: yaml_schema.md
  - Reference:
      - Main: reference/main.md
      - YAML model: reference/yaml_model.md
      - Test bench: reference/test_bench.md
      - Run configuration: reference/run_configuration.md
      - Plotting submodule: reference/plot.md
      - TUI submodule: reference/tui.md
      - Roofline model: reference/roofline_model.md
  - Gallery: gallery.md
  - Contributing: contributing.md

theme:
  name: material
  locale: en_GB
  features:
    - announce.dismiss
    - content.code.annotate
    - content.code.copy
    - navigation.footer
    - navigation.indexes
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.top
    #  - navigation.tracking
    - search.highlight
    - search.suggest
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/weather-sunny
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: black
      toggle:
        icon: material/weather-night
        name: Switch to light mode

markdown_extensions:
  # Inbuilt extensions
  # https://python-markdown.github.io/extensions/
  - admonition
  - attr_list
  - footnotes
  - md_in_html
  - meta
  - sane_lists
  - smarty
  - tables
  - toc:
      permalink: true
  # Third party extensions
  # https://facelessuser.github.io/pymdown-extensions/
  # https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.highlight:
      linenums: true
      anchor_linenums: true
  - pymdownx.keys
  - pymdownx.saneheaders
  - pymdownx.smartsymbols
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde

plugins:
  - search
  #  - minify:
  #      minify_html: true
  - mkdocstrings:
      handlers:
        python:
          options:
            docstring_style: google
            members_order: source
            show_root_heading: true
            show_root_full_path: false
            show_signature_annotations: true
            filters:
              - "!UFloat" # Ignore strange type wrapper causing warnings

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/EdmundGoodman
      name: Python Template on Github

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