HIP runtime API reference reorganize

docs/doxygen/Doxyfile

@@ -829,8 +829,7 @@ WARN_LOGFILE           =
 # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
 # Note: If this tag is empty the current directory is searched.
 
-INPUT                  = mainpage.md \
-                         ../../include/hip \
+INPUT                  = ../../include/hip \
                          ../../../clr/hipamd/include/hip/amd_detail/amd_hip_gl_interop.h \
                          ../../../clr/hipamd/include/hip/amd_detail/amd_surface_functions.h \
                          ../../../clr/hipamd/include/hip/amd_detail/amd_hip_cooperative_groups.h \

docs/index.md

@@ -50,17 +50,18 @@ The HIP documentation is organized into the following categories:
 
 :::{grid-item-card} Reference
 
-* {doc}`/doxygen/html/index`
+* [HIP runtime API](./reference/hip_runtime_api_reference)
+    * {ref}`modules_reference`
+    * {doc}`doxygen/html/annotated_data_structures`
+    * {doc}`doxygen/html/files_files`
+* [HSA runtime API for ROCm](./reference/virtual_rocr)
+* [HIP math API](./reference/math_api)
 * [C++ language extensions](./reference/cpp_language_extensions)
 * [C++ language support](./reference/cpp_language_support)
 * [Driver API](./reference/driver_api_reference)
 * [HIP math API](./reference/math_api)
 * [HIP environment variables](./reference/env_variables)
 * [Comparing syntax for different APIs](./reference/terms)
-* [HSA runtime API for ROCm](./reference/virtual_rocr)
-* [HIP managed memory allocation API](./reference/unified_memory_reference)
-* [HIP virtual memory management API](./reference/virtual_memory_reference)
-* [HIP Cooperative groups API](./reference/cooperative_groups_reference)
 * [List of deprecated APIs](./reference/deprecated_api_list)
 
 :::

docs/reference/hip_runtime_api/modules.rst

@@ -0,0 +1,39 @@
+.. meta::
+  :description: HIP runtime API modules reference page
+  :keywords: AMD, ROCm, HIP, CUDA, HIP runtime API modules
+
+.. _modules_reference:
+
+*******************************************************************************
+Modules
+*******************************************************************************
+
+The API is organized into modules based on functionality:
+
+* :ref:`global_enum_defines_reference`
+* :ref:`driver_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_memory_operations_reference`
+  * :ref:`unified_memory_reference`
+  * :ref:`virtual_memory_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:`texture_management_reference`
+* :ref:`runtime_compilation_reference`
+* :ref:`callback_activity_apis_reference`
+* :ref:`graph_management_reference`
+* :ref:`opengl_interop_reference`
+* :ref:`surface_object_reference`

docs/reference/hip_runtime_api/modules/callback_activity_apis.rst

@@ -0,0 +1,12 @@
+.. meta::
+  :description: This chapter is the callback activity APIs reference page.
+  :keywords: AMD, ROCm, HIP, CUDA, callback activity APIs, callback activity
+
+.. _callback_activity_apis_reference:
+
+*******************************************************************************
+Callback activity APIs
+*******************************************************************************
+
+.. doxygengroup:: Callback
+   :content-only:

docs/reference/hip_runtime_api/modules/context_management.rst

@@ -0,0 +1,12 @@
+.. meta::
+  :description: This chapter is the context management reference page.
+  :keywords: AMD, ROCm, HIP, CUDA, context management, context
+
+.. _context_management_reference:
+
+*******************************************************************************
+Context management [deprecated]
+*******************************************************************************
+
+.. doxygengroup:: Context
+   :content-only:

docs/reference/cooperative_groups_reference.rst → docs/reference/hip_runtime_api/modules/cooperative_groups_reference.rst

@@ -5,7 +5,7 @@
 .. _cooperative_groups_reference:
 
 *******************************************************************************
-HIP Cooperative groups API
+Cooperative groups API
 *******************************************************************************
 
 Cooperative kernel launches

docs/reference/hip_runtime_api/modules/device_management.rst

@@ -0,0 +1,12 @@
+.. meta::
+  :description: This chapter is the device management reference page
+  :keywords: AMD, ROCm, HIP, CUDA, device management, device
+
+.. _device_management_reference:
+
+*******************************************************************************
+Device management
+*******************************************************************************
+
+.. doxygengroup:: Device
+   :content-only:

docs/reference/hip_runtime_api/modules/error_handling.rst

@@ -0,0 +1,12 @@
+.. meta::
+  :description: This chapter is the error handling reference page
+  :keywords: AMD, ROCm, HIP, CUDA, error handling, error
+
+.. _error_handling_reference:
+
+*******************************************************************************
+Error handling
+*******************************************************************************
+
+.. doxygengroup:: Error
+   :content-only:

docs/reference/hip_runtime_api/modules/event_management.rst

@@ -0,0 +1,12 @@
+.. meta::
+  :description: This chapter is the event management reference page
+  :keywords: AMD, ROCm, HIP, CUDA, event management, event
+
+.. _event_management_reference:
+
+*******************************************************************************
+Event management
+*******************************************************************************
+
+.. doxygengroup:: Event
+   :content-only:

docs/reference/hip_runtime_api/modules/execution_control.rst

@@ -0,0 +1,12 @@
+.. meta::
+  :description: This chapter is the execution control reference page
+  :keywords: AMD, ROCm, HIP, CUDA, execution control, execution
+
+.. _execution_control_reference:
+
+*******************************************************************************
+Execution control
+*******************************************************************************
+
+.. doxygengroup:: Execution
+   :content-only:

docs/reference/hip_runtime_api/modules/global_enum_and_defines.rst

@@ -0,0 +1,12 @@
+.. meta::
+  :description: This chapter is the global enum and defines reference page
+  :keywords: AMD, ROCm, HIP, CUDA, global enum, defines
+
+.. _global_enum_defines_reference:
+
+*******************************************************************************
+Global enum and defines
+*******************************************************************************
+
+.. doxygengroup:: GlobalDefs
+   :content-only:

docs/reference/hip_runtime_api/modules/graph_management.rst

@@ -0,0 +1,12 @@
+.. meta::
+  :description: This chapter is the graph management reference page.
+  :keywords: AMD, ROCm, HIP, CUDA, graph management, graph
+
+.. _graph_management_reference:
+
+*******************************************************************************
+Graph management
+*******************************************************************************
+
+.. doxygengroup:: Graph
+   :content-only:

docs/reference/hip_runtime_api/modules/initialization_and_version.rst

@@ -0,0 +1,12 @@
+.. meta::
+  :description: This chapter is the initialization and version reference page
+  :keywords: AMD, ROCm, HIP, CUDA, initialization, version
+
+.. _driver_reference:
+
+*******************************************************************************
+Initialization and version
+*******************************************************************************
+
+.. doxygengroup:: Driver
+   :content-only:

docs/reference/hip_runtime_api/modules/launch_api.rst

@@ -0,0 +1,13 @@
+.. meta::
+  :description: This chapter is the launch API to support the triple-chevron
+                syntax reference page.
+  :keywords: AMD, ROCm, HIP, CUDA, launch API, triple-chevron
+
+.. _launch_api_reference:
+
+*******************************************************************************
+Launch API to support the triple-chevron syntax
+*******************************************************************************
+
+.. doxygengroup:: Clang
+   :content-only:

docs/reference/hip_runtime_api/modules/memory_management.rst

@@ -0,0 +1,12 @@
+.. meta::
+  :description: This chapter is the memory management reference page
+  :keywords: AMD, ROCm, HIP, CUDA, memory management, memory
+
+.. _memory_management_reference:
+
+*******************************************************************************
+Memory management
+*******************************************************************************
+
+.. doxygengroup:: Memory
+   :content-only:

docs/reference/hip_runtime_api/modules/memory_management/external_resource_interoperability.rst

@@ -0,0 +1,13 @@
+.. meta::
+  :description: This chapter is the external resource interoperability reference
+                page.
+  :keywords: AMD, ROCm, HIP, CUDA, external resource interoperability
+
+.. _external_resource_interoperability_reference:
+
+*******************************************************************************
+External resource interoperability
+*******************************************************************************
+
+.. doxygengroup:: External
+   :content-only:

docs/reference/hip_runtime_api/modules/memory_management/stream_memory_operations.rst

@@ -0,0 +1,12 @@
+.. meta::
+  :description: This chapter is the stream memory operations reference page
+  :keywords: AMD, ROCm, HIP, CUDA, stream memory operations
+
+.. _stream_memory_operations_reference:
+
+*******************************************************************************
+Stream memory operations
+*******************************************************************************
+
+.. doxygengroup:: StreamM
+   :content-only:

docs/reference/unified_memory_reference.rst → docs/reference/hip_runtime_api/modules/memory_management/unified_memory_reference.rst

@@ -6,7 +6,7 @@
 .. _unified_memory_reference:
 
 *******************************************************************************
-HIP managed memory allocation API
+Managed memory allocation API
 *******************************************************************************
 
 .. doxygengroup:: MemoryM

docs/reference/virtual_memory_reference.rst → docs/reference/hip_runtime_api/modules/memory_management/virtual_memory_reference.rst

@@ -6,7 +6,7 @@
 .. _virtual_memory_reference:
 
 *******************************************************************************
-HIP virtual memory management API
+Virtual memory management API
 *******************************************************************************
 
 .. doxygengroup:: Virtual

docs/reference/hip_runtime_api/modules/module_management.rst

@@ -0,0 +1,12 @@
+.. meta::
+  :description: This chapter is the module management reference page.
+  :keywords: AMD, ROCm, HIP, CUDA, module management, module
+
+.. _module_management_reference:
+
+*******************************************************************************
+Module management
+*******************************************************************************
+
+.. doxygengroup:: Module
+   :content-only:

docs/reference/hip_runtime_api/modules/occupancy.rst

@@ -0,0 +1,12 @@
+.. meta::
+  :description: This chapter is the occupancy reference page.
+  :keywords: AMD, ROCm, HIP, CUDA, occupancy
+
+.. _occupancy_reference:
+
+*******************************************************************************
+Occupancy
+*******************************************************************************
+
+.. doxygengroup:: Occupancy
+   :content-only:

docs/reference/hip_runtime_api/modules/opengl_interop.rst

@@ -0,0 +1,12 @@
+.. meta::
+  :description: This chapter is the OpenGL interop reference page.
+  :keywords: AMD, ROCm, HIP, CUDA, OpenGL interop
+
+.. _opengl_interop_reference:
+
+*******************************************************************************
+OpenGL interop
+*******************************************************************************
+
+.. doxygengroup:: OpenGL
+   :content-only:

docs/reference/hip_runtime_api/modules/peer_to_peer_device_memory_access.rst

@@ -0,0 +1,13 @@
+.. meta::
+  :description: This chapter is the peer to peer device memory access reference
+                page.
+  :keywords: AMD, ROCm, HIP, CUDA, peer to peer device memory access, peer to peer
+
+.. _peer_to_peer_device_memory_access_reference:
+
+*******************************************************************************
+Peer to peer device memory access
+*******************************************************************************
+
+.. doxygengroup:: PeerToPeer
+   :content-only:

docs/reference/hip_runtime_api/modules/profiler_control.rst

@@ -0,0 +1,12 @@
+.. meta::
+  :description: This chapter is the profiler control reference page.
+  :keywords: AMD, ROCm, HIP, CUDA, profiler control, profiler
+
+.. _profiler_control_reference:
+
+*******************************************************************************
+Profiler control
+*******************************************************************************
+
+.. doxygengroup:: Profiler
+   :content-only:

docs/reference/hip_runtime_api/modules/runtime_compilation.rst

@@ -0,0 +1,12 @@
+.. meta::
+  :description: This chapter is the runtime compilation reference page.
+  :keywords: AMD, ROCm, HIP, CUDA, runtime compilation
+
+.. _runtime_compilation_reference:
+
+*******************************************************************************
+Runtime compilation
+*******************************************************************************
+
+.. doxygengroup:: Runtime
+   :content-only:

docs/reference/hip_runtime_api/modules/stream_management.rst

@@ -0,0 +1,12 @@
+.. meta::
+  :description: This chapter is the stream management reference page
+  :keywords: AMD, ROCm, HIP, CUDA, stream management, stream
+
+.. _stream_management_reference:
+
+*******************************************************************************
+Stream management
+*******************************************************************************
+
+.. doxygengroup:: Stream
+   :content-only: