rocm-systems/projects/rocprofiler-compute/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: 6
root: index
subtrees:
  - entries:
    - file: what-is-omniperf.rst

  - caption: Install
    entries:
    - file: install/core-install.rst
    - file: install/grafana-setup.rst
      title: Grafana server for Omniperf

  - caption: How to
    entries:
    - file: how-to/use.rst
    - file: how-to/profile/mode.rst
    - file: how-to/analyze/mode.rst
      entries:
      - file: how-to/analyze/cli.rst
      - file: how-to/analyze/grafana-gui.rst
      - file: how-to/analyze/standalone-gui.rst

  - caption: Conceptual
    entries:
    - file: conceptual/performance-model.rst
      entries:
      - file: conceptual/compute-unit.rst
        title: Compute unit
        entries:
        - file: conceptual/pipeline-descriptions.rst
        - file: conceptual/pipeline-metrics.rst
        - file: conceptual/local-data-share.rst
          title: Local data share
        - file: conceptual/vector-l1-cache.rst
          title: Vector L1 cache
      - file: conceptual/l2-cache.rst
        title: L2 cache
      - file: conceptual/shader-engine.rst
        title: Shader engine
      - file: conceptual/command-processor.rst
        title: Command processor
      - file: conceptual/system-speed-of-light.rst
        title: System Speed-of-Light
      - file: conceptual/references.rst
    - file: conceptual/definitions.rst

  - caption: Tutorials
    entries:
    - file: tutorial/profiling-by-example.rst
    - file: tutorial/learning-resources.rst

  - caption: Reference
    entries:
    - file: reference/compatible-accelerators.rst
    - file: reference/faq.rst
    - file: license.rst