doc: added the NAS benchmark

bh107 · Apr 28, 2017 · 812aac5 · 812aac5
1 parent 7009055
commit 812aac5
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 1 deletion.
diff --git a/doc/source/conf.py b/doc/source/conf.py
@@ -28,6 +28,7 @@ def _script_path():
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 sys.path.insert(0, os.path.abspath(os.path.join('..', '..')))
+sys.path.insert(1, os.path.abspath(os.path.join('..', '..', 'benchpress', 'suites')))
 
 on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
 

diff --git a/doc/source/index.rst b/doc/source/index.rst
@@ -13,8 +13,9 @@ Contents:
 |    :maxdepth: 2              |    :maxdepth: 2              |
 |                              |                              |
 |    quickstart                |                              |
-|    install                   |                              |
+|    install                   |    suites                    |
 |    usage_commands            |    benchmarks                |
 |    implementing              |                              |
+|    implementing              |                              |
 |    reference/index           |                              |
 +------------------------------+------------------------------+
diff --git a/doc/source/suites.rst b/doc/source/suites.rst
@@ -0,0 +1,13 @@
+Suites
+------
+
+.. automodule:: nas_parallel_benchmark
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+**The Source:**
+
+.. literalinclude:: ../../benchpress/suites/nas_parallel_benchmark.py
+    :language: python