Rename the cooperative groups reference file, minor coop groups update

ROCm · May 14, 2024 · d35ccd3 · d35ccd3
1 parent 27d3e89
commit d35ccd3
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 29 deletions.
diff --git a/docs/how-to/cooperative_groups.rst b/docs/how-to/cooperative_groups.rst
@@ -146,26 +146,7 @@ Constructed via:
 
 The ``group_index()`` , ``thread_index()`` , ``thread_rank()`` , ``size()``, ``cg_type()``,  
 ``is_valid()`` , ``sync()`` and ``group_dim()`` member functions are public of the 
-thread_block class. For further details check the :doc:`thread_block references <reference:cooperative_groups>` . 
-
-Tiled Group
--------------
-
-Represents one tiled thread group in a wavefront. This group type also supports sub-wave
-level intrinsics.
-
-.. code-block:: C++
-
-  class thread_block;
-
-Constructed via:
-
-.. code-block:: C++
-
-  thread_block g = this_thread_block();
-
-The ``thread_rank()`` , ``size()``, ``cg_type()``, ``is_valid()`` and ``sync()`` member functions
-are public of the ``thread_block`` class. For further details check the :doc:`thread_block references <reference:cooperative_groups>`. 
+thread_block class. For further details check the :ref:`thread_block references <thread_block_ref>` . 
 
 Grid Group
 ------------
@@ -185,7 +166,7 @@ Constructed via:
   grid_group g = this_grid();
 
 The ``thread_rank()`` , ``size()``, ``cg_type()``, ``is_valid()`` and ``sync()`` member functions
-are public of the ``grid_group`` class. For further details check the :doc:`grid_group references <reference:cooperative_groups>`. 
+are public of the ``grid_group`` class. For further details check the :ref:`grid_group references <grid_group_ref>`. 
 
 Multi Grid Group
 ------------------
@@ -207,7 +188,7 @@ Constructed via:
 
 The ``num_grids()`` , ``grid_rank()`` , ``thread_rank()``, ``size()``, ``cg_type()``, ``is_valid()`` ,
 and ``sync()`` member functions are public of the ``multi_grid_group`` class. For
-further details check the :doc:`multi_grid_group references <reference:cooperative_groups>` . 
+further details check the :ref:`multi_grid_group references <multi_grid_group_ref>` . 
 
 Thread Block Tile
 ------------------
@@ -236,7 +217,7 @@ Constructed via:
 The ``thread_rank()`` , ``size()``, ``cg_type()``, ``is_valid()``, ``sync()``, 
 ``meta_group_rank()``, ``meta_group_size()``, ``shfl(...)``, ``shfl_down(...)``, 
 ``shfl_up(...)`` and ``shfl_xor(...)`` member functions are public of the ``thread_block_tile``
-class. For further details check the :doc:`thread_block_tile references <reference:cooperative_groups>` . 
+class. For further details check the :ref:`thread_block_tile references <thread_block_tile_ref>` . 
 
 Coalesced Groups
 ------------------
@@ -261,7 +242,7 @@ Constructed via:
 The ``thread_rank()`` , ``size()``, ``cg_type()``, ``is_valid()``, ``sync()``, 
 ``meta_group_rank()``, ``meta_group_size()``, ``shfl(...)``, ``shfl_down(...)``, 
 and ``shfl_up(...)`` member functions are public of the ``coalesced_group`` class. 
-For further details check the :doc:`coalesced_group references <reference:cooperative_groups>` .
+For further details check the :ref:`coalesced_group references <coalesced_group_ref>` .
 
 Synchronization
 =================

diff --git a/docs/reference/cooperative_groups.rst → ...eference/cooperative_groups_reference.rst b/docs/reference/cooperative_groups.rst → ...eference/cooperative_groups_reference.rst
@@ -22,16 +22,22 @@ The following functions are located in the https://github.com/ROCm/clr repositor
 
 .. doxygenfunction:: cooperative_groups::tiled_partition(const thread_group &parent, unsigned int tile_size)
 
-.. doxygenclass:: cooperative_groups::thread_block
+.. _thread_block_ref:
 
-.. doxygenclass:: cooperative_groups::thread_block_tile_type
+.. doxygenclass:: cooperative_groups::thread_block
 
-.. doxygenclass:: cooperative_groups::thread_group
+.. _grid_group_ref:
 
 .. doxygenclass:: cooperative_groups::grid_group
 
+.. _multi_grid_group_ref:
+
 .. doxygenclass:: cooperative_groups::multi_grid_group
 
-.. doxygenclass:: cooperative_groups::tiled_group
+.. _thread_block_tile_ref:
+
+.. doxygenclass:: cooperative_groups::thread_block_tile
+
+.. _coalesced_group_ref:
 
 .. doxygenclass:: cooperative_groups::coalesced_group
diff --git a/docs/sphinx/_toc.yml.in b/docs/sphinx/_toc.yml.in
@@ -38,7 +38,7 @@ subtrees:
     title: C++ language extensions
   - file: reference/terms
     title: Comparing Syntax for different APIs
-  - file: reference/cooperative_groups
+  - file: reference/cooperative_groups_reference
     title: Cooperative Groups API
   - file: reference/virtual_rocr
     title: HSA Runtime API for ROCm