Merge pull request #2266 from vkarak/testlib/fix-docs

[testlib] Fix test library docs and rearrange the Jupyter tests

Author: Vasileios Karakasis

cscs-checks/apps/jupyter/check_ipcmagic.py

@@ -5,7 +5,7 @@
 
 import reframe as rfm
 
-from hpctestlib.sciapps.jupyter.ipcmagic import ipcmagic_check
+from hpctestlib.interactive.jupyter.ipcmagic import ipcmagic_check
 
 
 @rfm.simple_test

cscs-checks/apps/spark/spark_check.py

@@ -5,7 +5,7 @@
 
 import reframe as rfm
 
-from hpctestlib.data_analytics.spark.compute_pi import compute_pi_check
+from hpctestlib.data_analytics.spark.spark_checks import compute_pi_check
 
 
 @rfm.simple_test

docs/hpctestlib.rst

@@ -7,7 +7,15 @@ This is a collection of generic tests that you can either run out-of-the-box by
 Scientific Applications
 -----------------------
 
-.. automodule:: hpctestlib.apps.amber.nve
+.. automodule:: hpctestlib.sciapps.amber.nve
+   :members:
+   :show-inheritance:
+
+
+Data Analytics
+--------------
+
+.. automodule:: hpctestlib.data_analytics.spark.spark_checks
    :members:
    :show-inheritance:
 
@@ -21,8 +29,8 @@ Python
 
 
 Interactive Computing
------------------------
+---------------------
 
-.. automodule:: hpctestlib.apps.jupyter.ipcmagic
+.. automodule:: hpctestlib.interactive.jupyter.ipcmagic
    :members:
    :show-inheritance:

hpctestlib/data_analytics/spark/compute_pi/__init__.py renamed to hpctestlib/data_analytics/spark/spark_checks.py

@@ -35,7 +35,7 @@ class compute_pi_check(rfm.RunOnlyRegressionTest, pin_prefix=True):
 
     #: Parameter encoding the variant of the test.
     #:
-    #: :type:`str`
+    #: :type: :class:`str`
     #: :values: ``['spark', 'pyspark']``
     variant = parameter(['spark', 'pyspark'])