# Variables of the form ${<variable>} are substituted, currently the following
# list is supported:
#   - ${branch} (or {branch}) the name of the current branch
#   - ${url} (or {url}) github url of the current project
#   - ${project:<project_name>} base url of the documentation of <project_name>
#     based on intersphinx_mapping.
# These comments will also be removed.
defaults:
  numbered: false
root: index
subtrees:
- caption: Install
  entries:
  - file: install/install.md
    title: Install AMD SMI
  - file: install/build.md
    title: Build from source

- caption: How to
  entries:
  - file: how-to/amdsmi-cpp-lib.md
    title: C/C++ library usage
  - file: how-to/amdsmi-py-lib.md
    title: Python library usage
  - file: how-to/amdsmi-go-lib.md
    title: Go library usage
  - file: how-to/amdsmi-cli-tool.md
    title: CLI tool usage
  - file: how-to/amdsmi-nic-integration.md
    title: AI NIC integration
  - file: how-to/setup-docker-container.md
    title: Use AMD SMI in a Docker container

- caption: Reference
  entries:
  - file: reference/amdsmi-cpp-api/index.md
    title: C/C++ API
    entries:
    - file: reference/amdsmi-cpp-api/functions.md
      title: Functions
    - file: reference/amdsmi-cpp-api/types.md
      title: Types
    - file: reference/amdsmi-cpp-api/defines.md
      title: Defines
  - file: reference/amdsmi-py-api.md
    title: Python API
  - file: reference/amdsmi-go-api.md
    title: Go API
  - file: reference/changelog.md
    title: Changelog

- caption: Conceptual
  entries:
  - file: conceptual/partition.md
    title: GPU partitioning
  - file: conceptual/gpu-reset-behavior.md
    title: GPU reset behavior
  - file: conceptual/gpu-violations.md
    title: GPU violations
  - file: conceptual/perf-determinism.md
    title: Performance determinism
  - file: conceptual/ras.md
    title: Reliability, availability, serviceability (RAS)
  - file: conceptual/test-design.md
    title: Test suite design

- caption: Tutorials
  entries:
  - url: https://github.com/ROCm/rocm-systems/tree/develop/projects/amdsmi/example
    title: AMD SMI examples (GitHub)
  - url: https://rocm.blogs.amd.com/software-tools-optimization/amd-smi-overview/README.html
    title: AMD SMI CLI walkthrough

- caption: About
  entries:
  - file: license.md