[docs] Improve readability of ROCprofiler-SDK API library documentation (#359)

* Use custom .rst to make api doc more readable. * Update index.rst * Misc docs updates - doxygen source code fixes - updated doxygen files - fixed conf.py (does not generate code in source tree) * Update source/docs/api-reference/rocprofiler-sdk_api_reference.rst Co-authored-by: Rawat, Swati <Swati.Rawat@amd.com> * Update source/docs/api-reference/rocprofiler-sdk_api_reference.rst Co-authored-by: Rawat, Swati <Swati.Rawat@amd.com> * Update source/docs/api-reference/rocprofiler-sdk_api/modules.rst Co-authored-by: Rawat, Swati <Swati.Rawat@amd.com> * Update source/docs/api-reference/rocprofiler-sdk_api/global_data_structures_topics_files.rst Co-authored-by: Rawat, Swati <Swati.Rawat@amd.com> * Duplicate * test warnings * Update CMakeLists.txt * Update rocprofiler-sdk.dox.in * Update update-docs.sh * fix docs build failures by -q -T flags. * set warn_as_error to NO. * test -W to suppress warnings. * remove -q flag from make. * reduce dot graph depth to 100 * Update custom docs target - docs target is now no longer part of the dependency list for the all target - installation of docs requires explicitly building the docs target (i.e. OPTIONAL install of _build/html/ folder) * add quit and trace mode back. * increase DOT_GRAPH_MAX_NODES to 500 back. * Format. --------- Co-authored-by: Venkateshwar Reddy Kandula <vkandula@amd.com> Co-authored-by: Jonathan R. Madsen <jonathanrmadsen@gmail.com> Co-authored-by: Bhardwaj, Gopesh <Gopesh.Bhardwaj@amd.com> Co-authored-by: Rawat, Swati <Swati.Rawat@amd.com> Co-authored-by: Madsen, Jonathan <Jonathan.Madsen@amd.com>
2025-05-14 00:47:51 -05:00
@@ -0,0 +1,15 @@
+.. meta::
+  :description: The Global Data structures, topics and files reference page.
+
+.. _global_data_structures_topics_files_reference:
+
+*******************************************************************************
+Global Data structures, topics, files
+*******************************************************************************
+
+This ROCprofiler-SDK API topic covers:
+
+* :ref:`global_basic_data_types_reference`
+* :doc:`../../_doxygen/rocprofiler-sdk/html/topics`
+* :doc:`../../_doxygen/rocprofiler-sdk/html/annotated`
+* :doc:`../../_doxygen/rocprofiler-sdk/html/files`
@@ -0,0 +1,11 @@
+.. meta::
+  :description: The global basic data types reference page.
+
+.. _global_basic_data_types_reference:
+
+*******************************************************************************
+Global Basic Data Types
+*******************************************************************************
+
+.. doxygengroup:: BASIC_DATA_TYPES
+   :content-only:
@@ -0,0 +1,28 @@
+.. meta::
+  :description: The ROCprofiler-SDK API modules reference page.
+  :keywords: AMD, ROCm, modules
+
+.. _modules_reference:
+
+*******************************************************************************
+Modules
+*******************************************************************************
+
+The ROCprofiler-SDK API is organized into the following modules based on functionality:
+
+* :ref:`agent_information_reference`
+* :ref:`buffer_handling_reference`
+* :ref:`buffer_tracing_reference`
+* :ref:`callback_tracing_reference`
+* :ref:`context_management_reference`
+* :ref:`counters_reference`
+* :ref:`counter_config_reference`
+* :ref:`device_counting_service_reference`
+* :ref:`dispatch_counting_service_reference`
+* :ref:`external_correlation_reference`
+* :ref:`intercept_table_reference`
+* :ref:`internal_threading_management_reference`
+* :ref:`ompt_registration_reference`
+* :ref:`pc_sampling_service_reference`
+* :ref:`thread_trace_reference`
+* :ref:`tool_registration_reference`
@@ -0,0 +1,11 @@
+.. meta::
+  :description: The Agent Information reference page.
+
+.. _agent_information_reference:
+
+*******************************************************************************
+Agent Information
+*******************************************************************************
+
+.. doxygengroup:: AGENTS
+   :content-only:
@@ -0,0 +1,11 @@
+.. meta::
+  :description: The buffer handling reference page.
+
+.. _buffer_handling_reference:
+
+*******************************************************************************
+Buffer handling
+*******************************************************************************
+
+.. doxygengroup:: BUFFER_HANDLING
+   :content-only:
@@ -0,0 +1,11 @@
+.. meta::
+  :description: The buffer tracing reference page.
+
+.. _buffer_tracing_reference:
+
+*******************************************************************************
+Buffer tracing
+*******************************************************************************
+
+.. doxygengroup:: BUFFER_TRACING_SERVICE
+   :content-only:
@@ -0,0 +1,11 @@
+.. meta::
+  :description: The callback tracing reference page.
+
+.. _callback_tracing_reference:
+
+*******************************************************************************
+Callback tracing
+*******************************************************************************
+
+.. doxygengroup:: CALLBACK_TRACING_SERVICE
+   :content-only:
@@ -0,0 +1,11 @@
+.. meta::
+  :description: The context management reference page.
+
+.. _context_management_reference:
+
+*******************************************************************************
+Context management
+*******************************************************************************
+
+.. doxygengroup:: CONTEXT_OPERATIONS
+   :content-only:
@@ -0,0 +1,11 @@
+.. meta::
+  :description: The counter config reference page.
+
+.. _counter_config_reference:
+
+*******************************************************************************
+Counter config
+*******************************************************************************
+
+.. doxygengroup:: COUNTER_CONFIG
+   :content-only:
@@ -0,0 +1,11 @@
+.. meta::
+  :description: The counters reference page.
+
+.. _counters_reference:
+
+*******************************************************************************
+Counters
+*******************************************************************************
+
+.. doxygengroup:: COUNTERS
+   :content-only:
@@ -0,0 +1,11 @@
+.. meta::
+  :description: The device counting service reference page.
+
+.. _device_counting_service_reference:
+
+*******************************************************************************
+Device counting service
+*******************************************************************************
+
+.. doxygengroup:: device_counting_service
+   :content-only:
@@ -0,0 +1,11 @@
+.. meta::
+  :description: The dispatch counting service reference page.
+
+.. _dispatch_counting_service_reference:
+
+*******************************************************************************
+Dispatch counting service
+*******************************************************************************
+
+.. doxygengroup:: dispatch_counting_service
+   :content-only:
@@ -0,0 +1,11 @@
+.. meta::
+  :description: The external correlation reference page.
+
+.. _external_correlation_reference:
+
+*******************************************************************************
+External correlation
+*******************************************************************************
+
+.. doxygengroup:: EXTERNAL_CORRELATION
+   :content-only:
@@ -0,0 +1,11 @@
+.. meta::
+  :description: The Intercept table reference page.
+
+.. _intercept_table_reference:
+
+*******************************************************************************
+Intercept table
+*******************************************************************************
+
+.. doxygengroup:: INTERCEPT_TABLE
+   :content-only:
@@ -0,0 +1,11 @@
+.. meta::
+  :description: The intenal threading management reference page.
+
+.. _internal_threading_management_reference:
+
+*******************************************************************************
+Internal threading management
+*******************************************************************************
+
+.. doxygengroup:: INTERNAL_THREADING
+   :content-only:
@@ -0,0 +1,11 @@
+.. meta::
+  :description: The OMPT Registration reference page.
+
+.. _ompt_registration_reference:
+
+*******************************************************************************
+OMPT Registration
+*******************************************************************************
+
+.. doxygengroup:: OMPT_REGISTRATION
+   :content-only:
@@ -0,0 +1,11 @@
+.. meta::
+  :description: The PC Sampling service reference page.
+
+.. _pc_sampling_service_reference:
+
+*******************************************************************************
+PC Sampling service
+*******************************************************************************
+
+.. doxygengroup:: PC_SAMPLING_SERVICE
+   :content-only:
@@ -0,0 +1,11 @@
+.. meta::
+  :description: The thread trace reference page.
+
+.. _thread_trace_reference:
+
+*******************************************************************************
+Thread trace
+*******************************************************************************
+
+.. doxygengroup:: THREAD_TRACE
+   :content-only:
@@ -0,0 +1,11 @@
+.. meta::
+  :description: The tool registration reference page.
+
+.. _tool_registration_reference:
+
+*******************************************************************************
+Tool registration
+*******************************************************************************
+
+.. doxygengroup:: REGISTRATION_GROUP
+   :content-only:
@@ -0,0 +1,14 @@
+.. meta::
+  :description: ROCprofiler-SDK API reference page
+  :keywords: AMD, ROCm, HSA
+
+.. _rocprofiler_sdk_api_reference:
+
+********************************************************************************
+ROCprofiler-SDK API library
+********************************************************************************
+
+This ROCprofiler-SDK API topic covers:
+
+* :ref:`modules_reference`
+* :ref:`global_data_structures_topics_files_reference`