rocm-systems/projects/rocshmem/docs/sphinx/_toc.yml.in

defaults:
  numbered: False
root: index
subtrees:

- entries:
  - file: introduction.rst
    title: What is rocSHMEM?

- caption: Install
  entries:
  - file: install.rst
    title: Install rocSHMEM


- caption: How to
  entries:
  - file: compile_and_run.rst
    title: Compile and run applications

- caption: API reference
  entries:
  - file: api/init.rst
    title: Library setup, exit, and query routines
  - file: api/memory_management.rst
    title: Memory management routines
  - file: api/teams.rst
    title: Team management routines
  - file: api/ctx.rst
    title: Context management routines
  - file: api/env_variables.rst
    title: Environment variables
  - file: api/rma.rst
    title: Remote memory access routines
  - file: api/amo.rst
    title: Atomic memory operations
  - file: api/sigops.rst
    title: Signaling operations
  - file: api/coll.rst
    title: Collective routines
  - file: api/pt2pt_sync.rst
    title: Point-to-point synchronization routines
  - file: api/memory_ordering.rst
    title: Memory ordering routines

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