# 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-rocprof-compute.rst

  - caption: Install
    entries:
    - file: install/core-install.rst
      title: Install ROCm Compute Profiler
    - file: install/source-install.rst
      title: Install from source
    - file: install/quickstart.rst
      title: Quickstart

  - caption: How to
    entries:
    - file: how-to/use.rst
    - file: how-to/pc_sampling.rst
      title: Use PC sampling
    - file: how-to/live_attach_detach.rst
      title: Use Dynamic process attachment
    - file: how-to/profile/mode.rst
    - file: how-to/analyze/mode.rst
      entries:
      - file: how-to/analyze/cli.rst
      - file: how-to/analyze/standalone-gui.rst
      - file: how-to/analyze/tui.rst
      - file: how-to/analyze/optiq.rst

  - caption: Conceptual
    entries:
    - file: conceptual/performance-model.rst
      entries:
      - file: conceptual/cdna/cdna-performance-model.rst
        title: CDNA-CDNA4
        entries:
        - file: conceptual/cdna/system-speed-of-light.rst
          title: System Speed-of-Light
        - file: conceptual/cdna/compute-unit.rst
          title: Compute unit
          entries:
          - file: conceptual/cdna/pipeline-descriptions.rst
          - file: conceptual/cdna/pipeline-metrics.rst
          - file: conceptual/cdna/local-data-share.rst
            title: Local data share
          - file: conceptual/cdna/vector-l1-cache.rst
            title: Vector L1 cache
        - file: conceptual/cdna/l2-cache.rst
          title: L2 cache
        - file: conceptual/cdna/shader-engine.rst
          title: Shader engine
        - file: conceptual/cdna/command-processor.rst
          title: Command processor (CP)
        - file: conceptual/cdna/references.rst
      - file: conceptual/rdna/rdna-performance-model.rst
        title: RDNA3
        entries:
        - file: conceptual/rdna/system-speed-of-light.rst
          title: System Speed-of-Light
        - file: conceptual/rdna/shader-engine.rst
          title: Shader engine
          entries:
          - file: conceptual/rdna/spi.rst
            title: Workgroup Manager (SPI)
          - file: conceptual/rdna/wgp.rst
            title: Workgroup processor (WGP)
          - file: conceptual/rdna/gl0-cache.rst
            title: GL0 (TCP Vector Cache)
          - file: conceptual/rdna/gl1-cache.rst
            title: GL1
        - file: conceptual/rdna/gl2-cache.rst
          title: GL2
        - file: conceptual/rdna/gcea.rst
          title: GCEA
        - file: conceptual/rdna/command-processor.rst
          title: Command processor (CP)
        - file: conceptual/rdna/grbm.rst
          title: Graphics Register Bus Manager (GRBM)
        - file: conceptual/rdna/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