Update

ROCm · Sep 20, 2024 · 460eeb3 · 460eeb3
1 parent 99492fc
commit 460eeb3
Show file tree

Hide file tree

Showing 32 changed files with 94 additions and 72 deletions.
diff --git a/docs/index.md b/docs/index.md
@@ -54,6 +54,8 @@ On non-AMD platforms, like NVIDIA, HIP provides header files required to support
 :::{grid-item-card} Reference
 
 * [HIP runtime API](./reference/hip_runtime_api_reference)
+  * [Modules](./reference/hip_runtime_api/modules)
+  * [Global defines, enums, structs and files](./reference/hip_runtime_api/global_defines_enums_structs_files)
 * [HSA runtime API for ROCm](./reference/virtual_rocr)
 * [C++ language extensions](./reference/cpp_language_extensions)
 * [C++ language support](./reference/cpp_language_support)

diff --git a/docs/reference/hip_runtime_api/global_defines_enums_structs_files.rst b/docs/reference/hip_runtime_api/global_defines_enums_structs_files.rst
@@ -0,0 +1,14 @@
+.. meta::
+  :description: The global defines, enum, structs and files reference page.
+
+.. _global_defines_enums_structs_files_reference:
+
+*******************************************************************************
+Global defines, enums, structs and files
+*******************************************************************************
+
+The structs, define macros, enums and files in the HIP runtime API.
+
+* :ref:`global_enum_defines_reference`
+* :doc:`hip:doxygen/html/annotated`
+* :doc:`hip:doxygen/html/files`
diff --git a/...p_runtime_api/global_enum_and_defines.rst → ...structs_files/global_enum_and_defines.rst b/...p_runtime_api/global_enum_and_defines.rst → ...structs_files/global_enum_and_defines.rst
diff --git a/docs/reference/hip_runtime_api/modules.rst b/docs/reference/hip_runtime_api/modules.rst
@@ -0,0 +1,40 @@
+.. meta::
+  :description: The HIP runtime API modules reference page.
+  :keywords: AMD, ROCm, HIP, CUDA, HIP runtime API modules, modules
+
+.. _modules_reference:
+
+*******************************************************************************
+Modules
+*******************************************************************************
+
+The API is organized into modules based on functionality.
+
+* :ref:`initialization_version_reference`
+* :ref:`device_management_reference`
+* :ref:`execution_control_reference`
+* :ref:`error_handling_reference`
+* :ref:`stream_management_reference`
+* :ref:`stream_memory_operations_reference`
+* :ref:`event_management_reference`
+* :ref:`memory_management_reference`
+
+  * :ref:`external_resource_interoperability_reference`
+  * :ref:`stream_ordered_memory_allocator_reference`
+  * :ref:`unified_memory_reference`
+  * :ref:`virtual_memory_reference`
+  * :ref:`texture_management_reference`
+  * :ref:`texture_management_deprecated_reference`
+  * :ref:`surface_object_reference`
+
+* :ref:`peer_to_peer_device_memory_access_reference`
+* :ref:`context_management_reference`
+* :ref:`module_management_reference`
+* :ref:`occupancy_reference`
+* :ref:`profiler_control_reference`
+* :ref:`launch_api_reference`
+* :ref:`runtime_compilation_reference`
+* :ref:`callback_activity_apis_reference`
+* :ref:`graph_management_reference`
+* :ref:`opengl_interoperability_reference`
+* :ref:`cooperative_groups_reference`
diff --git a/...ip_runtime_api/callback_activity_apis.rst → ...me_api/modules/callback_activity_apis.rst b/...ip_runtime_api/callback_activity_apis.rst → ...me_api/modules/callback_activity_apis.rst
diff --git a/...ce/hip_runtime_api/context_management.rst → ...untime_api/modules/context_management.rst b/...ce/hip_runtime_api/context_management.rst → ...untime_api/modules/context_management.rst
diff --git a/...time_api/cooperative_groups_reference.rst → .../modules/cooperative_groups_reference.rst b/...time_api/cooperative_groups_reference.rst → .../modules/cooperative_groups_reference.rst
diff --git a/...nce/hip_runtime_api/device_management.rst → ...runtime_api/modules/device_management.rst b/...nce/hip_runtime_api/device_management.rst → ...runtime_api/modules/device_management.rst
diff --git a/...erence/hip_runtime_api/error_handling.rst → ...ip_runtime_api/modules/error_handling.rst b/...erence/hip_runtime_api/error_handling.rst → ...ip_runtime_api/modules/error_handling.rst
diff --git a/...ence/hip_runtime_api/event_management.rst → ..._runtime_api/modules/event_management.rst b/...ence/hip_runtime_api/event_management.rst → ..._runtime_api/modules/event_management.rst
diff --git a/...nce/hip_runtime_api/execution_control.rst → ...runtime_api/modules/execution_control.rst b/...nce/hip_runtime_api/execution_control.rst → ...runtime_api/modules/execution_control.rst
diff --git a/...ence/hip_runtime_api/graph_management.rst → ..._runtime_api/modules/graph_management.rst b/...ence/hip_runtime_api/graph_management.rst → ..._runtime_api/modules/graph_management.rst
diff --git a/...untime_api/initialization_and_version.rst → ...pi/modules/initialization_and_version.rst b/...untime_api/initialization_and_version.rst → ...pi/modules/initialization_and_version.rst
diff --git a/.../reference/hip_runtime_api/launch_api.rst → ...ce/hip_runtime_api/modules/launch_api.rst b/.../reference/hip_runtime_api/launch_api.rst → ...ce/hip_runtime_api/modules/launch_api.rst
diff --git a/...nce/hip_runtime_api/memory_management.rst → ...runtime_api/modules/memory_management.rst b/...nce/hip_runtime_api/memory_management.rst → ...runtime_api/modules/memory_management.rst
diff --git a/...nt/external_resource_interoperability.rst → ...nt/external_resource_interoperability.rst b/...nt/external_resource_interoperability.rst → ...nt/external_resource_interoperability.rst
diff --git a/...ement/stream_ordered_memory_allocator.rst → ...ement/stream_ordered_memory_allocator.rst b/...ement/stream_ordered_memory_allocator.rst → ...ement/stream_ordered_memory_allocator.rst
diff --git a/..._api/memory_management/surface_object.rst → ...ules/memory_management/surface_object.rst b/..._api/memory_management/surface_object.rst → ...ules/memory_management/surface_object.rst
diff --git a/.../memory_management/texture_management.rst → .../memory_management/texture_management.rst b/.../memory_management/texture_management.rst → .../memory_management/texture_management.rst
diff --git a/...agement/texture_management_deprecated.rst → ...agement/texture_management_deprecated.rst b/...agement/texture_management_deprecated.rst → ...agement/texture_management_deprecated.rst
diff --git a/...y_management/unified_memory_reference.rst → ...y_management/unified_memory_reference.rst b/...y_management/unified_memory_reference.rst → ...y_management/unified_memory_reference.rst
diff --git a/...y_management/virtual_memory_reference.rst → ...y_management/virtual_memory_reference.rst b/...y_management/virtual_memory_reference.rst → ...y_management/virtual_memory_reference.rst
diff --git a/...nce/hip_runtime_api/module_management.rst → ...runtime_api/modules/module_management.rst b/...nce/hip_runtime_api/module_management.rst → ...runtime_api/modules/module_management.rst
diff --git a/docs/reference/hip_runtime_api/occupancy.rst → ...nce/hip_runtime_api/modules/occupancy.rst b/docs/reference/hip_runtime_api/occupancy.rst → ...nce/hip_runtime_api/modules/occupancy.rst
diff --git a/...p_runtime_api/opengl_interoperability.rst → ...e_api/modules/opengl_interoperability.rst b/...p_runtime_api/opengl_interoperability.rst → ...e_api/modules/opengl_interoperability.rst
diff --git a/...api/peer_to_peer_device_memory_access.rst → ...les/peer_to_peer_device_memory_access.rst b/...api/peer_to_peer_device_memory_access.rst → ...les/peer_to_peer_device_memory_access.rst
diff --git a/...ence/hip_runtime_api/profiler_control.rst → ..._runtime_api/modules/profiler_control.rst b/...ence/hip_runtime_api/profiler_control.rst → ..._runtime_api/modules/profiler_control.rst
diff --git a/...e/hip_runtime_api/runtime_compilation.rst → ...ntime_api/modules/runtime_compilation.rst b/...e/hip_runtime_api/runtime_compilation.rst → ...ntime_api/modules/runtime_compilation.rst
diff --git a/...nce/hip_runtime_api/stream_management.rst → ...runtime_api/modules/stream_management.rst b/...nce/hip_runtime_api/stream_management.rst → ...runtime_api/modules/stream_management.rst
diff --git a/..._runtime_api/stream_memory_operations.rst → ..._api/modules/stream_memory_operations.rst b/..._runtime_api/stream_memory_operations.rst → ..._api/modules/stream_memory_operations.rst
diff --git a/docs/reference/hip_runtime_api_reference.rst b/docs/reference/hip_runtime_api_reference.rst
@@ -8,47 +8,7 @@
 HIP runtime API
 ********************************************************************************
 
-This is the full HIP Runtime API reference. 
+The HIP Runtime API reference:
 
-Modules
-================================================================================
-
-The API is organized into modules based on functionality.
-
-* :ref:`initialization_version_reference`
-* :ref:`device_management_reference`
-* :ref:`execution_control_reference`
-* :ref:`error_handling_reference`
-* :ref:`stream_management_reference`
-* :ref:`stream_memory_operations_reference`
-* :ref:`event_management_reference`
-* :ref:`memory_management_reference`
-
-  * :ref:`external_resource_interoperability_reference`
-  * :ref:`stream_ordered_memory_allocator_reference`
-  * :ref:`unified_memory_reference`
-  * :ref:`virtual_memory_reference`
-  * :ref:`texture_management_reference`
-  * :ref:`texture_management_deprecated_reference`
-  * :ref:`surface_object_reference`
-
-* :ref:`peer_to_peer_device_memory_access_reference`
-* :ref:`context_management_reference`
-* :ref:`module_management_reference`
-* :ref:`occupancy_reference`
-* :ref:`profiler_control_reference`
-* :ref:`launch_api_reference`
-* :ref:`runtime_compilation_reference`
-* :ref:`callback_activity_apis_reference`
-* :ref:`graph_management_reference`
-* :ref:`opengl_interoperability_reference`
-* :ref:`cooperative_groups_reference`
-
-Global defines, enums, structs and files
-================================================================================
-
-The structs, define macros, enums and files in the HIP runtime API.
-
-* :ref:`global_enum_defines_reference`
-* :doc:`hip:doxygen/html/annotated`
-* :doc:`hip:doxygen/html/files`
+* :ref:`modules_reference`
+* :ref:`global_defines_enums_structs_files_reference`
diff --git a/docs/sphinx/_toc.yml.in b/docs/sphinx/_toc.yml.in
@@ -40,37 +40,43 @@ subtrees:
   - file: reference/hip_runtime_api_reference
     subtrees:
     - entries:
-      - file: reference/hip_runtime_api/initialization_and_version
-      - file: reference/hip_runtime_api/device_management
-      - file: reference/hip_runtime_api/execution_control
-      - file: reference/hip_runtime_api/error_handling
-      - file: reference/hip_runtime_api/stream_management
-      - file: reference/hip_runtime_api/stream_memory_operations
-      - file: reference/hip_runtime_api/event_management
-      - file: reference/hip_runtime_api/memory_management
+      - file: reference/hip_runtime_api/modules
         subtrees:
         - entries:
-          - file: reference/hip_runtime_api/memory_management/external_resource_interoperability
-          - file: reference/hip_runtime_api/memory_management/stream_ordered_memory_allocator
-          - file: reference/hip_runtime_api/memory_management/unified_memory_reference
-          - file: reference/hip_runtime_api/memory_management/virtual_memory_reference
-          - file: reference/hip_runtime_api/memory_management/texture_management
-          - file: reference/hip_runtime_api/memory_management/texture_management_deprecated
-          - file: reference/hip_runtime_api/memory_management/surface_object
-      - file: reference/hip_runtime_api/peer_to_peer_device_memory_access
-      - file: reference/hip_runtime_api/context_management
-      - file: reference/hip_runtime_api/module_management
-      - file: reference/hip_runtime_api/occupancy
-      - file: reference/hip_runtime_api/profiler_control
-      - file: reference/hip_runtime_api/launch_api
-      - file: reference/hip_runtime_api/runtime_compilation
-      - file: reference/hip_runtime_api/callback_activity_apis
-      - file: reference/hip_runtime_api/graph_management
-      - file: reference/hip_runtime_api/opengl_interoperability
-      - file: reference/hip_runtime_api/cooperative_groups_reference
-      - file: reference/hip_runtime_api/global_enum_and_defines
-      - file: doxygen/html/annotated
-      - file: doxygen/html/files
+          - file: reference/hip_runtime_api/modules/initialization_and_version
+          - file: reference/hip_runtime_api/modules/device_management
+          - file: reference/hip_runtime_api/modules/execution_control
+          - file: reference/hip_runtime_api/modules/error_handling
+          - file: reference/hip_runtime_api/modules/stream_management
+          - file: reference/hip_runtime_api/modules/stream_memory_operations
+          - file: reference/hip_runtime_api/modules/event_management
+          - file: reference/hip_runtime_api/modules/memory_management
+            subtrees:
+            - entries:
+              - file: reference/hip_runtime_api/modules/memory_management/external_resource_interoperability
+              - file: reference/hip_runtime_api/modules/memory_management/stream_ordered_memory_allocator
+              - file: reference/hip_runtime_api/modules/memory_management/unified_memory_reference
+              - file: reference/hip_runtime_api/modules/memory_management/virtual_memory_reference
+              - file: reference/hip_runtime_api/modules/memory_management/texture_management
+              - file: reference/hip_runtime_api/modules/memory_management/texture_management_deprecated
+              - file: reference/hip_runtime_api/modules/memory_management/surface_object
+          - file: reference/hip_runtime_api/modules/peer_to_peer_device_memory_access
+          - file: reference/hip_runtime_api/modules/context_management
+          - file: reference/hip_runtime_api/modules/module_management
+          - file: reference/hip_runtime_api/modules/occupancy
+          - file: reference/hip_runtime_api/modules/profiler_control
+          - file: reference/hip_runtime_api/modules/launch_api
+          - file: reference/hip_runtime_api/modules/runtime_compilation
+          - file: reference/hip_runtime_api/modules/callback_activity_apis
+          - file: reference/hip_runtime_api/modules/graph_management
+          - file: reference/hip_runtime_api/modules/opengl_interoperability
+          - file: reference/hip_runtime_api/modules/cooperative_groups_reference
+      - file: reference/hip_runtime_api/global_defines_enums_structs_files
+        subtrees:
+        - entries:
+          - file: reference/hip_runtime_api/global_defines_enums_structs_files/global_enum_and_defines
+          - file: doxygen/html/annotated
+          - file: doxygen/html/files
   - file: reference/virtual_rocr
   - file: reference/cpp_language_extensions
     title: C++ language extensions