[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>

source/docs/_toc.yml.in

@@ -31,8 +31,35 @@ subtrees:
       title: Counter collection services
     - file: api-reference/pc_sampling
       title: PC sampling
-    - file: _doxygen/rocprofiler-sdk/html/index
-      title: ROCprofiler-SDK API library
+    - file: api-reference/rocprofiler-sdk_api_reference
+      subtrees:
+      - entries:
+        - file: api-reference/rocprofiler-sdk_api/modules
+          subtrees:
+          - entries:
+            - file: api-reference/rocprofiler-sdk_api/modules/agent_information
+            - file: api-reference/rocprofiler-sdk_api/modules/buffer_handling
+            - file: api-reference/rocprofiler-sdk_api/modules/buffer_tracing
+            - file: api-reference/rocprofiler-sdk_api/modules/callback_tracing
+            - file: api-reference/rocprofiler-sdk_api/modules/context_management
+            - file: api-reference/rocprofiler-sdk_api/modules/counter_config
+            - file: api-reference/rocprofiler-sdk_api/modules/counters
+            - file: api-reference/rocprofiler-sdk_api/modules/device_counting_service
+            - file: api-reference/rocprofiler-sdk_api/modules/dispatch_counting_service
+            - file: api-reference/rocprofiler-sdk_api/modules/external_correalation
+            - file: api-reference/rocprofiler-sdk_api/modules/intercept_table
+            - file: api-reference/rocprofiler-sdk_api/modules/internal_threading_management
+            - file: api-reference/rocprofiler-sdk_api/modules/ompt_registration
+            - file: api-reference/rocprofiler-sdk_api/modules/pc_sampling_service
+            - file: api-reference/rocprofiler-sdk_api/modules/thread_trace
+            - file: api-reference/rocprofiler-sdk_api/modules/tool_registration
+        - file: api-reference/rocprofiler-sdk_api/global_data_structures_topics_files
+          subtrees:
+            - entries:
+              - file: api-reference/rocprofiler-sdk_api/global_data_structures_topics_files/global_basic_data_types
+              - file: _doxygen/rocprofiler-sdk/html/topics
+              - file: _doxygen/rocprofiler-sdk/html/annotated
+              - file: _doxygen/rocprofiler-sdk/html/files
     - file: _doxygen/roctx/html/index
       title: ROCTx API library
   - caption: Conceptual