site_name: IREE
site_url: https://iree-org.github.io/iree/

theme:
  name: material
  icon:
    repo: fontawesome/brands/github
    logo: iree/ghost
  favicon: ghost.svg
  custom_dir: overrides

  features:
    - navigation.instant # Faster loading

    # TODO(scotttodd): join mkdocs-material insiders for this
    - navigation.tracking # Update URL in address bar with the active anchor

    # TODO(scotttodd): decide if we want this
    #     these move sections from the left nav to tabs below the header
    # - navigation.tabs
    # - navigation.tabs.sticky  # insiders only

    # TODO(scotttodd): remove this if the number of pages grows too much
    - navigation.sections # Group sections without collapsible buttons

    - navigation.top # Back to top button

    - navigation.indexes # section names can link to index.md pages

    - content.code.annotate # Allow inline annotations
    - content.code.copy # Enable copy button
    - content.tabs.link # Link content tabs across site (e.g. Windows/Linux)

  palette:
    # Light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    # Dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: blue
      accent: blue
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

repo_url: https://github.com/iree-org/iree
repo_name: iree-org/iree
edit_uri: "" # Omit edit button (linking to GitHub) from each document

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/iree-org/iree
      name: IREE on GitHub
    - icon: fontawesome/brands/discord
      link: https://discord.gg/26P4xW4
      name: IREE Discord Server
    - icon: fontawesome/solid/users
      link: https://groups.google.com/forum/#!forum/iree-discuss
      name: IREE Discuss Google Group
  generator: false # TODO(scotttodd): join mkdocs-material insiders for this

extra_css:
  - assets/stylesheets/extra.css

copyright: Copyright &copy; 2023 The IREE Authors

markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - footnotes
  - meta
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:materialx.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg
      options:
        custom_icons:
          - overrides/.icons
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - tables
  - toc:
      permalink: true # TODO(scotttodd): icon: https://fonts.google.com/icons?selected=Material+Icons+Outlined:link

# Navigation with explicit ordering and nesting.
# https://www.mkdocs.org/user-guide/configuration/#nav
# Note: may include external links and titles are optional for internal links
nav:
  - Home: "index.md"
  - "Getting Started":
      - "getting-started/index.md"
      - TensorFlow: "getting-started/tensorflow.md"
      - TensorFlow Lite: "getting-started/tflite.md"
      - JAX: "getting-started/jax.md"
      - PyTorch: "getting-started/pytorch.md"
  - "Deployment configurations":
      - "deployment-configurations/index.md"
      - CPU: "deployment-configurations/cpu.md"
      - CPU - Bare-Metal: "deployment-configurations/bare-metal.md"
      - GPU - Vulkan: "deployment-configurations/gpu-vulkan.md"
      - GPU - CUDA/ROCm: "deployment-configurations/gpu-cuda-rocm.md"
  - "Building from source":
      - "building-from-source/index.md"
      - "building-from-source/getting-started.md"
      - "building-from-source/python-bindings-and-importers.md"
      - "building-from-source/android.md"
      - "building-from-source/ios.md"
      - "building-from-source/riscv.md"
  - "Bindings":
      - "bindings/index.md"
      - C API: "bindings/c-api.md"
      - Python: "bindings/python.md"
      - TensorFlow Lite: "bindings/tensorflow-lite.md"
  - "Extensions":
      - "extensions/index.md"
  - "Blog":
      - "blog/index.md"
      - CUDA backend: "blog/2021-10-15-cuda-backend.md"
      - Work in progress on Matrix Multiplication on CPU: "blog/2021-10-13-mmt4d.md"
      - TFLite Support via TOSA: "blog/2021-07-19-tflite-tosa.md"
  - "Reference":
      - Glossary: "reference/glossary.md"
      - Optimization Options: "reference/optimization-options.md"
  - "Community":
      - "community/index.md"