site_name: "ray-ascend"
site_description: "Ray Ascend"
site_author: "ray-ascend"

docs_dir: .
site_dir: ../site

nav:
  - Home: index.md
  - User Guide:
      - Overview: user_guide/index.md
      - Installation: user_guide/installation.md
      - HCCL Collective Communication: user_guide/hccl_collective.md
      - YR Direct Transport: user_guide/yr_transport.md
      - API Reference: user_guide/api_reference.md
      - Best Practices: user_guide/best_practices.md
  - Developer Guide:
      - Overview: developer_guide/index.md
      - Setup: developer_guide/setup.md
      - Contributing: developer_guide/contributing.md
      - Performance Testing: developer_guide/performance_testing.md
      - Performance Benchmark Report: developer_guide/performance_benchmark_report.md
theme:
  name: material
  language: en
  logo: logo/ray-ascend-logo.png
  favicon: logo/ray-ascend-logo.png
  features:
    - navigation.instant
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.top
    - toc.follow
    - search.suggest
    - search.highlight
    - search.share
    - content.code.copy
    - content.code.select
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: white
      accent: teal
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: black
      accent: teal
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode
  font:
    text: Inter
    code: JetBrains Mono
  icon:
    repo: fontawesome/brands/git-alt
    edit: material/pencil
    view: material/eye

extra_css:
  - stylesheets/extra.css

markdown_extensions:
  - toc:
      permalink: true
      title: On this page
  - admonition
  - footnotes
  - pymdownx.superfences
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.details
  - pymdownx.tabbed:
      alternate_style: true
  - attr_list
  - md_in_html

plugins:
  - search

extra:
  social:
    - icon: fontawesome/brands/git-alt
      link: https://gitcode.com/Ascend/ray-ascend