Add screenshots of report examples

Infineon · Dec 6, 2023 · 2b35558 · 2b35558
1 parent 949e6bb
commit 2b35558
Show file tree

Hide file tree

Showing 7 changed files with 38 additions and 3 deletions.
diff --git a/docs/_static/report_screenshots/example1.png b/docs/_static/report_screenshots/example1.png
diff --git a/docs/_static/report_screenshots/example2.png b/docs/_static/report_screenshots/example2.png
diff --git a/docs/_static/report_screenshots/example3.png b/docs/_static/report_screenshots/example3.png
diff --git a/docs/_static/report_screenshots/example4.png b/docs/_static/report_screenshots/example4.png
diff --git a/docs/_static/report_screenshots/example5.png b/docs/_static/report_screenshots/example5.png
diff --git a/docs/changelog.rst b/docs/changelog.rst
@@ -7,5 +7,6 @@ v0.6.0
 -   Added support for Python 3.12
 -   Added new :ref:`extension points <plugins/plugin:Hookspec Markers>` ``pharaoh_find_asset_render_template`` and
     ``pharaoh_get_asset_render_template_mappings``.
--   Change supported suffix for Jinja templates from ``.jinja`` to ``.jinja2``, since IDE integration is much better
+-   Changed supported suffix for Jinja templates from ``.jinja`` to ``.jinja2``, since IDE integration is much better
     with later.
+-   Updated documentation
diff --git a/docs/examples/demo_reports.rst b/docs/examples/demo_reports.rst
@@ -4,10 +4,44 @@ Demo Reports
 HTML
 ----
 
-.. image:: /_static/chirping_crickets.gif
+Measurement Report
+++++++++++++++++++
+
+The following images show an HTML measurement report with
+
+-   a custom Sphinx stylesheet/theme (based on the ReadTheDocs theme)
+-   many components from the `sphinx-design <https://sphinx-design.readthedocs.io/en/latest/>`_ extension
+    (included in `pharaoh-report`)
+-   custom JS components to render Pandas dataframes as interactive tables using `DataTables <https://datatables.net/>`_
+    (included in `pharaoh-report`)
+-   time series plots created with Plotly
+
+.. tab-set::
+
+    .. tab-item:: Screenshot 1
+
+        .. image:: /_static/report_screenshots/example1.png
+
+    .. tab-item:: Screenshot 2
+
+        .. image:: /_static/report_screenshots/example2.png
+
+    .. tab-item:: Screenshot 3
+
+        .. image:: /_static/report_screenshots/example3.png
+
+    .. tab-item:: Screenshot 4
+
+        .. image:: /_static/report_screenshots/example4.png
 
 
 Confluence
 ----------
 
-.. image:: /_static/chirping_crickets.gif
+Trend Report
+++++++++++++
+
+The following image shows a measurement trend report automatically uploaded to Confluence via the
+`Atlassian Confluence Builder <https://sphinxcontrib-confluencebuilder.readthedocs.io/en/stable/>`_:
+
+.. image:: /_static/report_screenshots/example5.png