docs: Fix docutils warnings (#59)

* fix typo

* fix `Lexing literal_block` docutils warning

* fix `Title underline too short` docutils warning

* use consistent file type

* fix `Malformed table` error

* improve index.rst and front-load TOC

[ROCm/rocprofiler-systems commit: a70034055e]
Tento commit je obsažen v:
Peter Park
2024-12-13 15:59:07 -05:00
odevzdal David Galiffi
rodič 78168bca8d
revize 92d23f72d2
16 změnil soubory, kde provedl 102 přidání a 97 odebrání
+3 -3
Zobrazit soubor
@@ -10,7 +10,7 @@ The following example shows how a program can use the ROCm Systems Profiler API
for run-time analysis.
ROCm Systems Profiler user API example program
========================================
==============================================
You can use the ROCm Systems Profiler API to define custom regions to profile and trace.
The following C++ program demonstrates this technique by calling several functions from the
@@ -157,7 +157,7 @@ ROCm Systems Profiler API, such as ``rocprofsys_user_push_region`` and
}
Linking the ROCm Systems Profiler libraries to another program
=======================================================
==============================================================
To link the ``rocprofiler-systems-user-library`` to another program,
use the following CMake and ``g++`` directives.
@@ -186,7 +186,7 @@ Output from the API example program
First, instrument and run the program.
.. code-block:: shell
.. code-block:: shell-session
$ rocprof-sys-instrument -l --min-instructions=8 -E custom_push_region -o -- ./user-api
...