diff --git a/docs/index.md b/docs/index.md index 2fd7cdf5c7..0ae77a8c0b 100644 --- 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 new file mode 100644 index 0000000000..7123ab5d77 --- /dev/null +++ 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/docs/reference/hip_runtime_api/global_enum_and_defines.rst b/docs/reference/hip_runtime_api/global_defines_enums_structs_files/global_enum_and_defines.rst similarity index 100% rename from docs/reference/hip_runtime_api/global_enum_and_defines.rst rename to docs/reference/hip_runtime_api/global_defines_enums_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 new file mode 100644 index 0000000000..4d8f15c671 --- /dev/null +++ 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/docs/reference/hip_runtime_api/callback_activity_apis.rst b/docs/reference/hip_runtime_api/modules/callback_activity_apis.rst similarity index 100% rename from docs/reference/hip_runtime_api/callback_activity_apis.rst rename to docs/reference/hip_runtime_api/modules/callback_activity_apis.rst diff --git a/docs/reference/hip_runtime_api/context_management.rst b/docs/reference/hip_runtime_api/modules/context_management.rst similarity index 100% rename from docs/reference/hip_runtime_api/context_management.rst rename to docs/reference/hip_runtime_api/modules/context_management.rst diff --git a/docs/reference/hip_runtime_api/cooperative_groups_reference.rst b/docs/reference/hip_runtime_api/modules/cooperative_groups_reference.rst similarity index 100% rename from docs/reference/hip_runtime_api/cooperative_groups_reference.rst rename to docs/reference/hip_runtime_api/modules/cooperative_groups_reference.rst diff --git a/docs/reference/hip_runtime_api/device_management.rst b/docs/reference/hip_runtime_api/modules/device_management.rst similarity index 100% rename from docs/reference/hip_runtime_api/device_management.rst rename to docs/reference/hip_runtime_api/modules/device_management.rst diff --git a/docs/reference/hip_runtime_api/error_handling.rst b/docs/reference/hip_runtime_api/modules/error_handling.rst similarity index 100% rename from docs/reference/hip_runtime_api/error_handling.rst rename to docs/reference/hip_runtime_api/modules/error_handling.rst diff --git a/docs/reference/hip_runtime_api/event_management.rst b/docs/reference/hip_runtime_api/modules/event_management.rst similarity index 100% rename from docs/reference/hip_runtime_api/event_management.rst rename to docs/reference/hip_runtime_api/modules/event_management.rst diff --git a/docs/reference/hip_runtime_api/execution_control.rst b/docs/reference/hip_runtime_api/modules/execution_control.rst similarity index 100% rename from docs/reference/hip_runtime_api/execution_control.rst rename to docs/reference/hip_runtime_api/modules/execution_control.rst diff --git a/docs/reference/hip_runtime_api/graph_management.rst b/docs/reference/hip_runtime_api/modules/graph_management.rst similarity index 100% rename from docs/reference/hip_runtime_api/graph_management.rst rename to docs/reference/hip_runtime_api/modules/graph_management.rst diff --git a/docs/reference/hip_runtime_api/initialization_and_version.rst b/docs/reference/hip_runtime_api/modules/initialization_and_version.rst similarity index 100% rename from docs/reference/hip_runtime_api/initialization_and_version.rst rename to docs/reference/hip_runtime_api/modules/initialization_and_version.rst diff --git a/docs/reference/hip_runtime_api/launch_api.rst b/docs/reference/hip_runtime_api/modules/launch_api.rst similarity index 100% rename from docs/reference/hip_runtime_api/launch_api.rst rename to docs/reference/hip_runtime_api/modules/launch_api.rst diff --git a/docs/reference/hip_runtime_api/memory_management.rst b/docs/reference/hip_runtime_api/modules/memory_management.rst similarity index 100% rename from docs/reference/hip_runtime_api/memory_management.rst rename to docs/reference/hip_runtime_api/modules/memory_management.rst diff --git a/docs/reference/hip_runtime_api/memory_management/external_resource_interoperability.rst b/docs/reference/hip_runtime_api/modules/memory_management/external_resource_interoperability.rst similarity index 100% rename from docs/reference/hip_runtime_api/memory_management/external_resource_interoperability.rst rename to docs/reference/hip_runtime_api/modules/memory_management/external_resource_interoperability.rst diff --git a/docs/reference/hip_runtime_api/memory_management/stream_ordered_memory_allocator.rst b/docs/reference/hip_runtime_api/modules/memory_management/stream_ordered_memory_allocator.rst similarity index 100% rename from docs/reference/hip_runtime_api/memory_management/stream_ordered_memory_allocator.rst rename to docs/reference/hip_runtime_api/modules/memory_management/stream_ordered_memory_allocator.rst diff --git a/docs/reference/hip_runtime_api/memory_management/surface_object.rst b/docs/reference/hip_runtime_api/modules/memory_management/surface_object.rst similarity index 100% rename from docs/reference/hip_runtime_api/memory_management/surface_object.rst rename to docs/reference/hip_runtime_api/modules/memory_management/surface_object.rst diff --git a/docs/reference/hip_runtime_api/memory_management/texture_management.rst b/docs/reference/hip_runtime_api/modules/memory_management/texture_management.rst similarity index 100% rename from docs/reference/hip_runtime_api/memory_management/texture_management.rst rename to docs/reference/hip_runtime_api/modules/memory_management/texture_management.rst diff --git a/docs/reference/hip_runtime_api/memory_management/texture_management_deprecated.rst b/docs/reference/hip_runtime_api/modules/memory_management/texture_management_deprecated.rst similarity index 100% rename from docs/reference/hip_runtime_api/memory_management/texture_management_deprecated.rst rename to docs/reference/hip_runtime_api/modules/memory_management/texture_management_deprecated.rst diff --git a/docs/reference/hip_runtime_api/memory_management/unified_memory_reference.rst b/docs/reference/hip_runtime_api/modules/memory_management/unified_memory_reference.rst similarity index 100% rename from docs/reference/hip_runtime_api/memory_management/unified_memory_reference.rst rename to docs/reference/hip_runtime_api/modules/memory_management/unified_memory_reference.rst diff --git a/docs/reference/hip_runtime_api/memory_management/virtual_memory_reference.rst b/docs/reference/hip_runtime_api/modules/memory_management/virtual_memory_reference.rst similarity index 100% rename from docs/reference/hip_runtime_api/memory_management/virtual_memory_reference.rst rename to docs/reference/hip_runtime_api/modules/memory_management/virtual_memory_reference.rst diff --git a/docs/reference/hip_runtime_api/module_management.rst b/docs/reference/hip_runtime_api/modules/module_management.rst similarity index 100% rename from docs/reference/hip_runtime_api/module_management.rst rename to docs/reference/hip_runtime_api/modules/module_management.rst diff --git a/docs/reference/hip_runtime_api/occupancy.rst b/docs/reference/hip_runtime_api/modules/occupancy.rst similarity index 100% rename from docs/reference/hip_runtime_api/occupancy.rst rename to docs/reference/hip_runtime_api/modules/occupancy.rst diff --git a/docs/reference/hip_runtime_api/opengl_interoperability.rst b/docs/reference/hip_runtime_api/modules/opengl_interoperability.rst similarity index 100% rename from docs/reference/hip_runtime_api/opengl_interoperability.rst rename to docs/reference/hip_runtime_api/modules/opengl_interoperability.rst diff --git a/docs/reference/hip_runtime_api/peer_to_peer_device_memory_access.rst b/docs/reference/hip_runtime_api/modules/peer_to_peer_device_memory_access.rst similarity index 100% rename from docs/reference/hip_runtime_api/peer_to_peer_device_memory_access.rst rename to docs/reference/hip_runtime_api/modules/peer_to_peer_device_memory_access.rst diff --git a/docs/reference/hip_runtime_api/profiler_control.rst b/docs/reference/hip_runtime_api/modules/profiler_control.rst similarity index 100% rename from docs/reference/hip_runtime_api/profiler_control.rst rename to docs/reference/hip_runtime_api/modules/profiler_control.rst diff --git a/docs/reference/hip_runtime_api/runtime_compilation.rst b/docs/reference/hip_runtime_api/modules/runtime_compilation.rst similarity index 100% rename from docs/reference/hip_runtime_api/runtime_compilation.rst rename to docs/reference/hip_runtime_api/modules/runtime_compilation.rst diff --git a/docs/reference/hip_runtime_api/stream_management.rst b/docs/reference/hip_runtime_api/modules/stream_management.rst similarity index 100% rename from docs/reference/hip_runtime_api/stream_management.rst rename to docs/reference/hip_runtime_api/modules/stream_management.rst diff --git a/docs/reference/hip_runtime_api/stream_memory_operations.rst b/docs/reference/hip_runtime_api/modules/stream_memory_operations.rst similarity index 100% rename from docs/reference/hip_runtime_api/stream_memory_operations.rst rename to docs/reference/hip_runtime_api/modules/stream_memory_operations.rst diff --git a/docs/reference/hip_runtime_api_reference.rst b/docs/reference/hip_runtime_api_reference.rst index d1056c7c18..e77490f79e 100644 --- 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` \ No newline at end of file +* :ref:`modules_reference` +* :ref:`global_defines_enums_structs_files_reference` diff --git a/docs/sphinx/_toc.yml.in b/docs/sphinx/_toc.yml.in index e7fb2d39b4..282abcf545 100644 --- 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