[docs] Add all modules in doc and remove warnings + doc Nix shell

Author: MERCIER Michael

docs/library_doc.rst

@@ -11,17 +11,38 @@ Workload: Handle Feitelson's SWF
    :members:
 
 
-JobSet: Handle Batsim output file
----------------------------------
+Handle Batsim output files
+--------------------------
 
 .. automodule:: evalys.jobset
    :members:
 
+.. automodule:: evalys.pstates
+   :members:
+
+.. automodule:: evalys.mstates
+   :members:
+
 
 Visualisation library
 ---------------------
 
-.. automodule:: evalys.visu
+.. automodule:: evalys.visu.gantt
+   :members:
+
+.. automodule:: evalys.visu.details
+   :members:
+
+.. automodule:: evalys.visu.lifecycle
+   :members:
+
+.. automodule:: evalys.visu.series
+   :members:
+
+.. automodule:: evalys.visu.core
+   :members:
+
+.. automodule:: evalys.visu.legacy
    :members:
 
 Metrics computation

docs/shell.nix

@@ -0,0 +1,16 @@
+let
+  kapack = import (fetchTarball https://github.com/oar-team/kapack/archive/master.tar.gz) {};
+in
+
+with kapack.pkgs;
+
+mkShell rec {
+  buildInputs = [
+    python36Packages.sphinx
+    python36Packages.sphinx_rtd_theme
+    kapack.evalys4
+  ];
+  shellHook = ''
+    sphinx-build . build
+  '';
+}

evalys/visu/core.py

@@ -43,8 +43,7 @@ class EvalysLayout:
     :ivar sps: The `SubplotSpec` defined in the layout.
     :vartype axes: dict
 
-    :ivar visualizations:
-        Binding of the visualizations injected into the layout.
+    :ivar visualizations: Binding of the visualizations injected into the layout.
         For each key `spskey` in `self.sps`, `self.visualizations[spskey]` is a
         list of the visualizations with root `SubplotSpec` `self.sps[spskey]`.
     :vartype visualizations: dict
@@ -75,11 +74,11 @@ def inject(self, visu_cls, spskey, *args, **kwargs):
             `Visualization` (or a subclass).  This key must exist in
             `self.sps`.
 
-        :param *args:
+        :param \*args:
             The positional arguments to be fed to the constructor of the
             visualization class.
 
-        :param **kwargs:
+        :param \**kwargs:
             The keyword arguments to be fed to the constructor of the
             visualization class.
 

evalys/visu/details.py

@@ -43,7 +43,7 @@ def plot_details(jobset, *, title='Workload overview', **kwargs):
     :param title: The title of the window.
     :type title: str
 
-    :param **kwargs:
+    :param \**kwargs:
         The keyword arguments to be fed to the constructors of the
         visualization classes.
     """

evalys/visu/gantt.py

@@ -31,8 +31,9 @@ class GanttVisualization(core.Visualization):
     :ivar xscale:
         The requested adaptation of the x-axis scale.
         Valid values are `None`, and `'time'`.
-        - It defaults to `None`, and uses raw values by default.
-        - If set to `time`, the x-axis interprets the data as timestamps, and
+
+        * It defaults to `None`, and uses raw values by default.
+        * If set to `time`, the x-axis interprets the data as timestamps, and
           uses a time-aware semantic.
 
     :ivar alpha:
@@ -198,12 +199,12 @@ def plot_gantt(jobset, *, title='Gantt chart', **kwargs):
     Helper function to create a Gantt chart of a workload.
 
     :param jobset: The jobset under study.
-    :type jobset: `JobSet`
+    :type jobset: ``JobSet``
 
     :param title: The title of the window.
-    :type title: str
+    :type title: ``str``
 
-    :param **kwargs:
+    :param \**kwargs:
         The keyword arguments to be fed to the constructor of the visualization
         class.
     """
@@ -225,7 +226,7 @@ def plot_diff_gantt(jobsets, *, title='Gantt charts comparison', **kwargs):
     :param title: The title of the window.
     :type title: str
 
-    :param **kwargs:
+    :param \**kwargs:
         The keyword arguments to be fed to the constructor of the visualization
         class.
     """

evalys/visu/lifecycle.py

@@ -54,15 +54,17 @@ class LifecycleVisualization(core.Visualization):
     :ivar xscale:
         The requested adaptation of the x-axis scale.
         Valid values are `None`, and `'time'`.
-        - It defaults to `None`, and uses raw values by default.
-        - If set to `time`, the x-axis interprets the data as timestamps, and
+
+        * It defaults to `None`, and uses raw values by default.
+        * If set to `time`, the x-axis interprets the data as timestamps, and
           uses a time-aware semantic.
 
     :ivar yscale:
         The requested adaptation of the y-axis scale.
         Valid values are `None`, and `'log2'`.
-        - It defaults to `None`, and uses raw values by default.
-        - If set to `log2`, the y-axis is transformed to show the values on a
+
+        * It defaults to `None`, and uses raw values by default.
+        * If set to `log2`, the y-axis is transformed to show the values on a
           logarithmic scale in base 2.
     """
 
@@ -203,9 +205,9 @@ def plot_lifecycle(jobset, *, title='Jobs\' life cycle', **kwargs):
     :type jobset: `JobSet`
 
     :param title: The title of the window.
-    :type title: str
+    :type title: `str`
 
-    :param **kwargs:
+    :param \**kwargs:
         The keyword arguments to be fed to the constructor of the visualization
         class.
     """

evalys/visu/series.py

@@ -25,8 +25,9 @@ class SeriesVisualization(core.Visualization):
     :ivar xscale:
         The requested adaptation of the x-axis scale.
         Valid values are `None`, and `'time'`.
-        - It defaults to `None`, and uses raw values by default.
-        - If set to `time`, the x-axis interprets the data as timestamps, and
+
+        * It defaults to `None`, and uses raw values by default.
+        * If set to `time`, the x-axis interprets the data as timestamps, and
           uses a time-aware semantic.
     """
     _metric = None
@@ -125,12 +126,12 @@ def plot_series(jobset, *, name, title='Time series plot', **kwargs):
     :type jobset: `JobSet`
 
     :param name: Name of the requested series visualization.
-    :type: str
+    :type: `str`
 
     :param title: The title of the window.
-    :type title: str
+    :type title: `str`
 
-    :param **kwargs:
+    :param \**kwargs:
         The keyword arguments to be fed to the constructor of the visualization
         class.
     """