Update driver api reference page

ROCm · Sep 30, 2024 · 6cc920e · 6cc920e
1 parent 246e2b6
commit 6cc920e
Show file tree

Hide file tree

Showing 6 changed files with 16 additions and 51 deletions.
diff --git a/docs/how-to/hip_porting_driver_api.rst b/docs/how-to/hip_porting_driver_api.rst
@@ -73,15 +73,15 @@ Notably, there is no fat binary format that can contain code for both NVCC and H
 The ``hipModule`` API can be used to load additional code objects. When used this way, it extends the capability of the automatically loaded code objects.
 HIP-Clang enables both of these capabilities to be used together. Of course, it is possible to create a program with no kernels and no automatic loading.
 
-For module API reference, visit :ref:`driver_api_module_reference`.
+For module API reference, visit :ref:`module_management_reference`.
 
 hipCtx API
 ----------
 
 HIP provides a ``Ctx`` API as a thin layer over the existing device functions. The ``Ctx`` API can be used to set the current context or to query properties of the device associated with the context.
 The current context is implicitly used by other APIs, such as ``hipStreamCreate``.
 
-For context reference, visit :ref:`driver_api_context_reference`.
+For context reference, visit :ref:`context_management_reference`.
 
 HIPIFY translation of CUDA driver API
 =====================================

diff --git a/docs/index.md b/docs/index.md
@@ -60,7 +60,6 @@ On non-AMD platforms, like NVIDIA, HIP provides header files required to support
 * [HSA runtime API for ROCm](./reference/virtual_rocr)
 * [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)
 * [Comparing syntax for different APIs](./reference/terms)
 * [List of deprecated APIs](./reference/deprecated_api_list)

diff --git a/docs/reference/driver_api_reference.rst b/docs/reference/driver_api_reference.rst
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
@@ -10,5 +10,6 @@ Global defines, enums, structs and files
 The structs, define macros, enums and files in the HIP runtime API.
 
 * :ref:`global_enum_defines_reference`
+* :ref:`driver_types_reference`
 * :doc:`hip:doxygen/html/annotated`
 * :doc:`hip:doxygen/html/files`
diff --git a/docs/reference/hip_runtime_api/global_defines_enums_structs_files/driver_types.rst b/docs/reference/hip_runtime_api/global_defines_enums_structs_files/driver_types.rst
@@ -0,0 +1,12 @@
+.. meta::
+ :description: The driver types reference page.
+ :keywords: AMD, ROCm, HIP, CUDA, driver types
+
+.. _driver_types_reference:
+
+*******************************************************************************
+Driver types
+*******************************************************************************
+
+.. doxygengroup:: DriverTypes
+ :content-only:
diff --git a/docs/sphinx/_toc.yml.in b/docs/sphinx/_toc.yml.in
@@ -78,14 +78,14 @@ subtrees:
  subtrees:
  - entries:
  - file: reference/hip_runtime_api/global_defines_enums_structs_files/global_enum_and_defines
+ - file: reference/hip_runtime_api/global_defines_enums_structs_files/driver_types
  - file: doxygen/html/annotated
  - file: doxygen/html/files
  - file: reference/virtual_rocr
  - file: reference/cpp_language_extensions
  title: C++ language extensions
  - file: reference/cpp_language_support
  title: C++ language support
- - file: reference/driver_api_reference
  - file: reference/math_api
  - file: reference/terms
  title: Comparing syntax for different APIs