Update README and fix docutils warnings (#289)

Signed-off-by: Russell McGuire <[email protected]>

Author: rwmcguir

scripts/README.md

@@ -1,16 +1,15 @@
 Python dependencies:
   * Python v3.6.6 or later
-  * [Mako Templates for Python](https://www.makotemplates.org/) v1.0.7
-  * [PyYAML](https://pyyaml.org/) v3.13
-  * [Sphinx](https://www.sphinx-doc.org/en/master/) v2.2.2
+  * [Mako Templates for Python](https://www.makotemplates.org/) v1.0.7 or later
+  * [PyYAML](https://pyyaml.org/) v3.13 or later
+  * [Sphinx](https://www.sphinx-doc.org/en/master/) v2.2.2 or later
 
 Installing Python dependencies:
 
   * Install all python requirements
   ~~~~
-    py -m pip install -r ..\third_party\requirements.txt
+    python3 -m pip install -r ../third_party/requirements.txt
   ~~~~
 
-Documentation is generated from source code using Doxygen.  
-  * [Doxygen](http://www.doxygen.nl/) v1.8.15
-  * [MiKTex](https://miktex.org/) v2.9.6930
+Documentation is generated from source code using Doxygen.
+  * [Doxygen](http://www.doxygen.nl/) v1.9.1 or later

scripts/core/EXT_Exp_KernelBinary.rst

@@ -42,12 +42,12 @@ The following pseudo-code shows how to obtain the kernel binary program data sav
     #include <fstream>
     //hKernel = valid kernel handle
     size_t kBinarySize = 0;
-    char *progArray;
+    char ``*``\progArray;
     ${x}KernelGetBinaryExp(hKernel, &KBinarysize, nullptr);
     progArray = new char[kBinarySize];
     ${x}KernelGetBinaryExp(hKernel, &kBinarySize, progArray);
     const std::string filePath = "program.bin";
     std::ofstream stream(filePath, std::ios::out | std::ios::binary);
-    stream.write(reinterpret_cast<const char *>(progArray), kBinarySize);
+    stream.write(reinterpret_cast<const char ``*``\>(progArray), kBinarySize);
     stream.close();
     delete[] progArray;

scripts/core/EXT_Exp_MutableCommandList.rst

@@ -257,14 +257,14 @@ Mutation of kernels must obey two rules:
 
     // Prepare to modify Kernel Argument
     int argValue = 1;
-    void *usmPointer;
+    void ``*``\usmPointer;
 
     ${x}_mutable_kernel_argument_exp_desc_t krnlArgMemoryDesc = {
         ${X}_STRUCTURE_TYPE_MUTABLE_KERNEL_ARGUMENT_EXP_DESC,     // stype
         &groupSizeDesc,                                         // pNext
         mutableKernelCommandId,                                 // commandId
         0,                                                      // argIndex
-        sizeof(void *),                                         // argSize
+        sizeof(void ``*``\),                                         // argSize
         &usmPointer                                             // pArgValue
     };
 

scripts/core/EXT_ExternalSemaphores.rst

@@ -61,10 +61,10 @@ Semantics and Behavior model
 
 Following pseudo-code demonstrates a sequence for importing external semaphore from Vulkan and using it in L0:
 
-..parsed-literal::
+.. parsed-literal::
     // Import external semaphore from Vulkan
     VkSemaphore vkSemaphore = ...;  // Create Vulkan semaphores
-    void *vkSemHandle = ...; //export VK semaphore
+    void ``*``\vkSemHandle = ...; //export VK semaphore
 
     ${x}_external_semaphore_win32_ext_desc_t win32Desc = {};
     win32Desc.handle = vkSemHandle;
@@ -87,4 +87,4 @@ Following pseudo-code demonstrates a sequence for importing external semaphore f
     ${x}_external_semaphore_signal_params_ext_t signalParams = {};
     signalParams.pNext = nullptr;
     ${x}CommandListAppendLaunchKernel(commandList, kernel, ..., event2, 0, nullptr);
-    ${x}CommandListAppendSignalExternalSemaphoreExt(commandList, &semaphore0, &signalParams, 1, event3, 1, &event2); 
+    ${x}CommandListAppendSignalExternalSemaphoreExt(commandList, &semaphore0, &signalParams, 1, event3, 1, &event2);

scripts/tools/EXT_Exp_ConcurrentMetricGroup.rst

@@ -12,9 +12,9 @@ from templates import helper as th
 
 .. _ZET_experimental_concurrent_metric_groups:
 
-==========================================
+=======================================================
 Concurrent Metric Groups Experimental Extension
-==========================================
+=======================================================
 
 API
 ----
@@ -66,4 +66,4 @@ The following pseudo-code shows how an application could query for sets of concu
         // run workload
 
         phMetricGroups += pCountPerConcurrentGroup[concurrentGroupIndex];
-    }
+    }

scripts/tools/EXT_Exp_MetricExportMemory.rst

@@ -12,9 +12,10 @@ from templates import helper as th
 
 .. _ZET_experimental_metric_export_memory:
 
-==============================================
- MetricGroup and Metric Export Memory Extension
-==============================================
+
+=======================================================
+MetricGroup and Metric Export Memory Extension
+=======================================================
 
 API
 ----

scripts/tools/EXT_Exp_MetricTracer.rst

@@ -71,18 +71,18 @@ Configuration
 -------------
 
 Use the ${t}ContextActivateMetricGroups API call to configure the device for data collection.
- 
+
 Collection
 ----------
 
-Metric Tracer based collection mode allows the creation of a tracer object for multiple metric groups than can be collected concurrently. Once metric groups are 
-activated the tracer can be created using ${t}MetricTracerCreateExp. Tracers are created in disabled state, applications have the flexibility to to enable 
-(${t}MetricTracerEnableExp) and disable (${t}MetricTracerDisableExp) during workload execution to selectively decide sections on which to collect metrics. 
+Metric Tracer based collection mode allows the creation of a tracer object for multiple metric groups than can be collected concurrently. Once metric groups are
+activated the tracer can be created using ${t}MetricTracerCreateExp. Tracers are created in disabled state, applications have the flexibility to to enable
+(${t}MetricTracerEnableExp) and disable (${t}MetricTracerDisableExp) during workload execution to selectively decide sections on which to collect metrics.
 ata can be retrieved from the tracer with ${t}MetricTracerReadDataExp.
 
 Decoding
 --------
-Metric Tracer collects the data in device specific, raw form that is not suitable for application processing. To convert data into a format that allows 
+Metric Tracer collects the data in device specific, raw form that is not suitable for application processing. To convert data into a format that allows
 application parsing a decoder object can be used. The decoder object is created with ${t}MetricDecoderCreateExp and data can be converted using
 ${t}MetricTracerDecodeExp. Each event in the data is associated with a decodable metric, which can be retrieved with ${t}MetricDecoderGetDecodableMetricsExp.
 
@@ -101,7 +101,7 @@ The following pseudo-code demonstrates how to enumerate Tracer based metric grou
     ${x}_event_pool_handle_t       hEventPool             = nullptr;
     ${x}_event_pool_desc_t         eventPoolDesc          = {${X}_STRUCTURE_TYPE_EVENT_POOL_DESC, nullptr, 0, 1};
     ${x}_event_desc_t              eventDesc              = {${X}_STRUCTURE_TYPE_EVENT_DESC};
-    ${t}_metric_tracer_exp_handle_t hMetricTracer         = nullptr; 
+    ${t}_metric_tracer_exp_handle_t hMetricTracer         = nullptr;
     ${t}_metric_tracer_exp_desc_t tracerDescriptor = { ${T}_STRUCTURE_TYPE_METRIC_TRACER_EXP_DESC, nullptr, 1024};
     ${t}_metric_decoder_exp_handle_t hMetricDecoder       = nullptr;
 
@@ -199,4 +199,4 @@ The following pseudo-code demonstrates how to enumerate Tracer based metric grou
     ${x}EventPoolDestroy( hEventPool );
 
     // Clean device configuration and free memory
-    ${t}ContextActivateMetricGroups( hContext, hDevice, 0, nullptr );
+    ${t}ContextActivateMetricGroups( hContext, hDevice, 0, nullptr );

scripts/tools/metricTracer.yml

@@ -267,7 +267,7 @@ params:
       name: phMetrics 
       desc: |
             [in] [range(0, metricsCount)] array of handles of decodable metrics in the decoder for which the hMetricDecoder handle was 
-            provided. Metrics handles are expected to be for decodable metrics, see $tMetricDecoderGetDecodableMetrics() 
+            provided. Metrics handles are expected to be for decodable metrics, see $tMetricDecoderGetDecodableMetricsExp() 
     - type: uint32_t*
       name: pSetCount
       desc: |