# 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-omnitrace.rst

  - caption: Install
    entries:
    - file: install/quick-start.rst
      title: Omnitrace quick start
    - file: install/install.rst
      title: Omnitrace installation guide

  - caption: Tutorials
    entries:
    - url: https://github.com/ROCm/omnitrace/tree/main/examples
      title: GitHub examples
    - file: tutorials/video-tutorials.rst
      title: Video tutorials

  - caption: How to
    entries:
    - file: how-to/configuring-validating-environment.rst
      title: Configuring and validating the environment 
    - file: how-to/configuring-runtime-options.rst
      title: Configuring runtime options 
    - file: how-to/sampling-call-stack.rst
      title: Sampling the call stack 
    - file: how-to/instrumenting-rewriting-binary-application.rst
      title: Instrumenting and rewriting a binary application
    - file: how-to/performing-causal-profiling.rst
      title: Performing causal profiling 
    - file: how-to/understanding-omnitrace-output.rst
      title: Understanding the Omnitrace output 
    - file: how-to/profiling-python-scripts.rst
      title: Profiling Python scripts  
    - file: how-to/using-omnitrace-api.rst
      title: Using the Omnitrace API
    - file: how-to/general-tips-using-omnitrace.rst 
      title: General tips for using Omnitrace 

  - caption: Conceptual
    entries:
    - file: conceptual/data-collection-modes.rst
      title: Data collection modes
    - file: conceptual/omnitrace-feature-set.rst
      title: The Omnitrace feature set and use cases

  - caption: Reference
    entries:
    - file: reference/development-guide.rst
      title: Development guide
    - file: reference/omnitrace-glossary.rst
      title: Omnitrace glossary
    - file: doxygen/html/files
      title: API library
    - file: doxygen/html/functions
      title: Class member functions
    - file: doxygen/html/globals
      title: Globals
    - file: doxygen/html/annotated
      title: Classes, structures, and interfaces

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