ROCm/docs/sphinx/_toc.yml.in

# Anywhere {branch} is used, the branch name will be substituted.
# These comments will also be removed.
defaults:
  numbered: False
  maxdepth: 7
root: index
subtrees:
- entries:
  - file: what-is-rocm.md
    title: What is ROCm?
    subtrees:
    - entries:
      - file: rocm-a-z.md
        title: ROCm A-Z
  - file: about/whats-new/whats-new.md
    title: What's new?

  - file: tutorials/quick-start/index.md
    title: Quick start
    subtrees:
    - entries:
      - file: tutorials/quick-start/linux.md
        title: Linux
      - file: tutorials/quick-start/windows.md
        title: Windows

  - file: about/compatibility/index.md
    title: Compatibility & support
    subtrees:
    - entries:
      - file: about/compatibility/linux-support.md
        title: Linux (GPU & OS)
      - file: about/compatibility/windows-support.md
        title: Windows (GPU & OS)
      - file: about/compatibility/3rd-party-support-matrix.md
        title: Third-party
      - file: about/compatibility/user-kernel-space-compat-matrix.md
        title: User/kernel space support
      - file: about/compatibility/docker-image-support-matrix.md
        title: Docker

  - file: about/release-notes.md
    title: Release information
    subtrees:
    - entries:
      - file: CHANGELOG.md
        title: Changelog
      - file: about/release-history.md
        title: Release history
      - url: https://github.com/RadeonOpenCompute/ROCm/labels/Verified%20Issue
        title: Known issues

  - file: tutorials/index.md
    title: Tutorials
    subtrees:
    - entries:
      - file: tutorials/install/index.md
        title: Installing ROCm
        subtrees:
        - entries:
          - file: tutorials/install/linux/index.md
            title: Linux
            subtrees:
            - entries:
              - file: tutorials/install/linux/prerequisites.md
                title: Prerequisites
              - file: tutorials/install/linux/install-options.md
                title: Installation options
                subtrees:
                - entries:
                  - file: tutorials/install/linux/installer/index.md
                    title: AMDGPU install script
                    subtrees:
                    - entries:
                      - file: tutorials/install/linux/installer/install.md
                        title: Install
                      - file: tutorials/install/linux/installer/upgrade.md
                        title: Upgrade
                      - file: tutorials/install/linux/installer/uninstall.md
                        title: Uninstall
                  - file: tutorials/install/linux/os-native/index.md
                    title: Package manager
                    subtrees:
                    - entries:
                      - file: tutorials/install/linux/os-native/package-manager-integration.md
                        title: Package manager integration
                      - file: tutorials/install/linux/os-native/install.md
                        title: Install
                      - file: tutorials/install/linux/os-native/upgrade.md
                        title: Upgrade
                      - file: tutorials/install/linux/os-native/uninstall.md
                        title: Uninstall
          - file: tutorials/install/windows/index.md
            title: Windows
            subtrees:
            - entries:
              - file: tutorials/install/windows/prerequisites.md
                title: Prerequisites
              - file: tutorials/install/windows/gui/index.md
                title: Graphical installation
                subtrees:
                - entries:
                  - file: tutorials/install/windows/gui/install.md
                    title: Install
                  - file: tutorials/install/windows/gui/upgrade.md
                    title: Upgrade
                  - file: tutorials/install/windows/gui/uninstall.md
                    title: Uninstall
              - file: tutorials/install/windows/cli/index.md
                title: Command-line installation
                subtrees:
                - entries:
                  - file: tutorials/install/windows/cli/install.md
                    title: Install
                  - file: tutorials/install/windows/cli/upgrade.md
                    title: Upgrade
                  - file: tutorials/install/windows/cli/uninstall.md
                    title: Uninstall
      - file: tutorials/install/docker.md
        title: ROCm Docker containers
      - file: tutorials/install/pytorch-install.md
        title: PyTorch for ROCm
      - file: tutorials/install/tensorflow-install.md
        title: Tensorflow for ROCm
      - file: tutorials/install/magma-install.md
        title: MAGMA for ROCm

  - file: how-to/index.md
    title: How-to
    subtrees:
    - entries:
      - file: how-to/deep-learning-rocm.md
        title: Deep learning
      - file: how-to/gpu-enabled-mpi.md
        title: Using MPI
      - file: how-to/system-debugging.md
        title: Debugging
      - file: how-to/tuning-guides/index.md
        title: Tuning guides
        subtrees:
        - entries:
          - file: how-to/tuning-guides/mi100.md
            title: MI100
          - file: how-to/tuning-guides/mi200.md
            title: MI200
          - file: how-to/tuning-guides/w6000-v620.md
            title: RDNA2

  - file: reference/index.md
    title: Reference guides
    subtrees:
    - entries:
      - file: reference/hip.md
        title: HIP
      - file: reference/compilers-tools/index.md
        title: Compilers & tools
        subtrees:
        - entries:
          - file: reference/compilers-tools/validation-tools.md
            title: Validation tools
          - file: reference/compilers-tools/management-tools.md
            title: Management tools
      - file: reference/libraries/index.md
        title: Libraries
        subtrees:
        - entries:
          - file: reference/libraries/ai-libraries.md
            title: AI
          - file: reference/libraries/gpu-libraries/communication.md
            title: Communication
          - file: reference/libraries/gpu-libraries/math.md
            title: Math
            subtrees:
            - entries:
              - file: reference/libraries/gpu-libraries/math-linear-algebra.md
                title: Linear algebra
              - file: reference/libraries/gpu-libraries/math-fft.md
                title: Fast Fourier transforms
          - file: reference/libraries/gpu-libraries/rand.md
            title: Random numbers
          - file: reference/libraries/gpu-libraries/c++primitives.md
            title: C++ primitives
      - file: reference/openmp/openmp.md
        title: OpenMP
      - file: reference/rocmcc/rocmcc.md
        title: ROCmCC

  - file: conceptual/index.md
    title: Conceptual documentation
    subtrees:
    - entries:
      - file: conceptual/gpu-arch.md
        title: GPU architectures
        subtrees:
        - entries:
          - file: conceptual/gpu-arch/mi100.md
            title: MI100
          - file: conceptual/gpu-arch/mi200-performance-counters.md
            title: MI200
          - file: conceptual/gpu-arch/mi250.md
            title: MI250
      - file: conceptual/gpu-memory.md
        title: GPU memory
      - file: conceptual/compiler-disambiguation.md
        title: Compiler disambiguation
      - file: conceptual/file-reorg.md
        title: File structure (Linux FHS)
      - file: conceptual/windows-app-deployment-guidelines.md
        title: Windows deployment guidelines
      - file: conceptual/gpu-isolation.md
        title: GPU isolation techniques
      - file: conceptual/using-gpu-sanitizer.md
        title: LLVN ASan
      - file: conceptual/cmake-packages.rst
        title: Using CMake
      - file: conceptual/More-about-how-ROCm-uses-PCIe-Atomics.rst
        title: ROCm & PCIe atomics
      - file: conceptual/ai-pytorch-inception.md
        title: Inception v3 with PyTorch
      - file: conceptual/ai-migraphx-optimization.md
        title: Inference optimization with MIGraphX

  - file: contribute/index.md
    title: Contributing
    subtrees:
    - entries:
      - file: contribute/toolchain.md
        title: Documentation tools
      - file: contribute/building.md
        title: Building documentation
      - file: contribute/feedback.md
        title: Providing feedback

  - file: about/license.md
    title: ROCm licensing

  - file: how-to/Spack.md
    title: Introduction to Spack