mkdocs.yml

site_name: Off-the-Grid MARL
site_author: InstaDeep Research
site_url: https://instadeepai.github.io/og-marl/
site_dir: public

theme:
  name: material
  logo: assets/instadeep_logo.png
  favicon: assets/instadeep_logo.png
  language: en
  features:
    - navigation.tracking # the URL is automatically updated with the active anchor
    - navigation.sections # top-level sections are rendered as groups in the sidebar
    - navigation.tabs # horizontal tabs at the top of the page
    - navigation.tabs.sticky # navigation tabs will lock below the header and always remain visible when scrolling
    - navigation.indexes # documents can be directly attached to sections
    - search.highlight # highlight search result
    - search.share # share button
    - search.suggest # smart suggestion
    - toc.integrate
    - toc.follow
    - content.code.annotate
    - navigation.tabs
    - navigation.top
  palette:
    - scheme: default
      primary: white
      accent: purple
      toggle:
        icon: material/weather-sunny
        name: Switch to dark mode
    - scheme: slate
      primary: black
      accent: lime
      toggle:
        icon: material/weather-night
        name: Switch to light mode

nav:
  - "Home": 'index.md'
  - "Research":
    - "": research/index.md
    - "Coordination Failure in Cooperative Offline MARL": research/polygames.md
    - "Selective Reincarnation in Multi-Agent Reinforcement Learning": research/selective-reincarnation.md
  - "Datasets":
      - "OG MARL": dataset_cards/og_marl.md
      - "CFCQL": dataset_cards/cfcql.md
      - "OMIGA": dataset_cards/omiga.md
      - "OMAR": dataset_cards/omar.md
      - "Alberdice": dataset_cards/alberdice.md
  - "Baseline Results":
    - "SMACv1": baselines/smac_v1.md
    - "SMACv2": baselines/smac_v2.md
    - "MAMuJoCo": baselines/mamujoco.md
    - "PettingZoo": baselines/pettingzoo.md
    - "Flatland": baselines/flatland.md
  # - "Updates": 'updates.md'
  # - "API Reference": 'api.md'

markdown_extensions:
  - attr_list
  - md_in_html
  - pymdownx.emoji:
      emoji_generator: !!python/name:pymdownx.emoji.to_svg
      emoji_index: !!python/name:pymdownx.emoji.gemoji
  - pymdownx.snippets:
      base_path: ./
  - pymdownx.pathconverter:
      base_path: ./
      relative_path: docs
  - toc:
      permalink: "#"
      toc_depth: 3
  - pymdownx.highlight:
      linenums: true
  - def_list
  - admonition
  - pymdownx.details
  - pymdownx.arithmatex:
      generic: true

extra_javascript:
  - js/katex.js
  - https://unpkg.com/katex@0/dist/katex.min.js
  - https://unpkg.com/katex@0/dist/contrib/auto-render.min.js

extra_css:
  - https://unpkg.com/katex@0/dist/katex.min.css

# Git repo
repo_name: instadeepai/og-marl
repo_url: https://github.com/instadeepai/og-marl
edit_uri: edit/develop/docs/

# Copyright
copyright: InstaDeep © 2022 Copyright, all rights reserved.