Dosyalar
rocm-systems/projects/rocprofiler-sdk/source/docs/api-reference/rocprofiler-sdk_api/modules.rst
T
Kandula, Venkateshwar reddy 89fbdeb196 [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>

[ROCm/rocprofiler-sdk commit: 6ec9526475]
2025-05-14 11:17:51 +05:30

29 satır
988 B
ReStructuredText

.. 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`