From 7e7d99db0e0264ca235d377cc85f7a13e8e55650 Mon Sep 17 00:00:00 2001
From: Peter Park <peter.park@amd.com>
Date: Mon, 13 Jan 2025 11:49:49 -0500
Subject: [PATCH] add metrics descriptions template for sphinx docs

Signed-off-by: Peter Park <peter.park@amd.com>
---
 .../performance-metrics-table.jinja           | 30 +++++++++++++++++++
 docs/conceptual/command-processor.rst         | 17 +++++++++++
 docs/conf.py                                  |  1 +
 3 files changed, 48 insertions(+)
 create mode 100644 docs/_templates/performance-metrics-table.jinja

diff --git a/docs/_templates/performance-metrics-table.jinja b/docs/_templates/performance-metrics-table.jinja
new file mode 100644
index 000000000..2a97ddaf2
--- /dev/null
+++ b/docs/_templates/performance-metrics-table.jinja
@@ -0,0 +1,30 @@
+.. -*- mode: rst -*-
+
+{% for data_source in data["Panel Config"]["data source"] %}
+
+## Anchor for internal linking.
+## For example, :ref:`command-processor-fetcher-metrics`.
+.. _{{data_source.metric_table.title|lower|replace(" ", "-") }}-metrics:
+
+{{ data_source.metric_table.title }}
+-------------------------------------------------------------------------------
+
+.. list-table::
+   :header-rows: 1
+
+   * - Metric
+     - Description
+     - Unit
+
+  {% for name, desc in data_source.metric_table.metric.items() %}
+   * - {{ name }}
+     - {{ desc.tips }}
+     - {{ desc.unit }}
+
+  {% endfor %}
+{% endfor %}
+
+.. note::
+
+   END
+
diff --git a/docs/conceptual/command-processor.rst b/docs/conceptual/command-processor.rst
index 873c8a3a6..821c326f7 100644
--- a/docs/conceptual/command-processor.rst
+++ b/docs/conceptual/command-processor.rst
@@ -46,6 +46,23 @@ processor’s metrics therefore are focused on reporting, for example:
 Command processor fetcher (CPF)
 ===============================
 
+.. tab-set::
+
+   .. tab-item:: MI300X
+
+      .. datatemplate:yaml:: ../../src/rocprof_compute_soc/analysis_configs/gfx90a/0500_command-processor.yaml
+         :template: ../_templates/performance-metrics-table.jinja
+
+   .. tab-item:: MI300X
+
+      .. datatemplate:yaml:: ../../src/rocprof_compute_soc/analysis_configs/gfx90a/0500_command-processor.yaml
+         :template: ../_templates/performance-metrics-table.jinja
+
+   .. tab-item:: MI300X
+
+      .. datatemplate:yaml:: ../../src/rocprof_compute_soc/analysis_configs/gfx90a/0500_command-processor.yaml
+         :template: ../_templates/performance-metrics-table.jinja
+
 .. list-table::
    :header-rows: 1
 
diff --git a/docs/conf.py b/docs/conf.py
index 95c0012cd..845ff0417 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -47,6 +47,7 @@
 html_title = f"{project} {version_number} documentation"
 exclude_patterns = ["archive", "*/includes"]
 
+templates_path = ["_templates"]
 html_static_path = ["sphinx/static/css"]
 html_css_files = ["o_custom.css"]