summaryrefslogtreecommitdiffstats
path: root/docs/userguide
diff options
context:
space:
mode:
Diffstat (limited to 'docs/userguide')
-rw-r--r--docs/userguide/annex.rst7
-rw-r--r--docs/userguide/benchmark-suites.rst9
-rw-r--r--docs/userguide/index.rst6
-rw-r--r--docs/userguide/introduction.rst24
4 files changed, 24 insertions, 22 deletions
diff --git a/docs/userguide/annex.rst b/docs/userguide/annex.rst
index 406d5132..ce1775d6 100644
--- a/docs/userguide/annex.rst
+++ b/docs/userguide/annex.rst
@@ -7,11 +7,10 @@
Annex
*****
-Templates
-=========
-
-.. include:: _testcase_description.rst
+.. toctree::
+ :maxdepth: 2
+ _testcase_description.rst
Downloads
=========
diff --git a/docs/userguide/benchmark-suites.rst b/docs/userguide/benchmark-suites.rst
index 9a3929cc..84d1c647 100644
--- a/docs/userguide/benchmark-suites.rst
+++ b/docs/userguide/benchmark-suites.rst
@@ -7,6 +7,9 @@
Benchmark Suites
****************
-.. include:: _01-compute.rst
-.. include:: _02-network.rst
-.. include:: _03-storage.rst
+.. toctree::
+ :maxdepth: 2
+
+ _01-compute.rst
+ _02-network.rst
+ _03-storage.rst
diff --git a/docs/userguide/index.rst b/docs/userguide/index.rst
index 3032f357..5ae4f345 100644
--- a/docs/userguide/index.rst
+++ b/docs/userguide/index.rst
@@ -11,6 +11,6 @@ QTIP User Guide
.. toctree::
:maxdepth: 2
- ./introduction.rst
- ./benchmark-suites.rst
- ./annex.rst
+ introduction.rst
+ benchmark-suites.rst
+ annex.rst
diff --git a/docs/userguide/introduction.rst b/docs/userguide/introduction.rst
index 2655347e..7a202a45 100644
--- a/docs/userguide/introduction.rst
+++ b/docs/userguide/introduction.rst
@@ -65,22 +65,22 @@ These files list the benchmarks are to be run by the QTIP framework. Sample
compute test file is shown below
::
-{
+ {
"bm": [
- "dhrystone_bm.yaml",
- "whetstone_bm.yaml",
- "ramspeed_bm.yaml",
- "dpi_bm.yaml",
- "ssl_bm.yaml"
+ "dhrystone_bm.yaml",
+ "whetstone_bm.yaml",
+ "ramspeed_bm.yaml",
+ "dpi_bm.yaml",
+ "ssl_bm.yaml"
],
"vm": [
- "dhrystone_vm.yaml",
- "whetstone_vm.yaml",
- "ramspeed_vm.yaml",
- "dpi_vm.yaml",
- "ssl_vm.yaml"
+ "dhrystone_vm.yaml",
+ "whetstone_vm.yaml",
+ "ramspeed_vm.yaml",
+ "dpi_vm.yaml",
+ "ssl_vm.yaml"
]
-}
+ }
The compute file will now run all the benchmarks listed above one after
another on the environment.