Updates the documentation

docs/conf.py

@@ -30,8 +30,14 @@ release = '1.0.0'
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
-    'sphinx.ext.autodoc'
+    #'sphinx.ext.autosummary',
+    'sphinx.ext.autodoc',
+    'myst_parser'
 ]
+autodoc_default_flags = ['members']
+#autosummary_generate = True
+
+#add_module_names = False
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
@@ -52,4 +58,4 @@ html_theme = 'sphinx_rtd_theme'
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+# html_static_path = ['_static']

docs/expetator.benchmarks.rst

 expetator.benchmarks package
 ============================
 
-Submodules
-----------
+.. autoclass:: expetator.benchmarks.cpubench.CpuBench
 
-expetator.benchmarks.genericbench module
-----------------------------------------
+.. autoclass:: expetator.benchmarks.genericbench.GenericBench
 
-.. automodule:: expetator.benchmarks.genericbench
-   :members:
-   :undoc-members:
-   :show-inheritance:
+.. autoclass:: expetator.benchmarks.gpucpubench.GpuCpuBench
 
-expetator.benchmarks.gpucpubench module
----------------------------------------
+.. autoclass:: expetator.benchmarks.gpumembench.GpuMemBench
 
-.. automodule:: expetator.benchmarks.gpucpubench
-   :members:
-   :undoc-members:
-   :show-inheritance:
+.. autoclass:: expetator.benchmarks.gromacsbench.GromacsBench
 
-expetator.benchmarks.gpumembench module
----------------------------------------
+.. autoclass:: expetator.benchmarks.membench.MemBench
 
-.. automodule:: expetator.benchmarks.gpumembench
-   :members:
-   :undoc-members:
-   :show-inheritance:
+.. autoclass:: expetator.benchmarks.mpibench.MpiBench
 
-expetator.benchmarks.gromacsbench module
-----------------------------------------
+.. autoclass:: expetator.benchmarks.npbbench.NpbBench
 
-.. automodule:: expetator.benchmarks.gromacsbench
-   :members:
-   :undoc-members:
-   :show-inheritance:
+.. autoclass:: expetator.benchmarks.percentagebench.PercentageBench
 
-expetator.benchmarks.membench module
-------------------------------------
+.. autoclass:: expetator.benchmarks.sleepbench.SleepBench
 
-.. automodule:: expetator.benchmarks.membench
-   :members:
-   :undoc-members:
-   :show-inheritance:
+.. autoclass:: expetator.benchmarks.watermark.WaterMark
 
-expetator.benchmarks.mpibench module
-------------------------------------
-
-.. automodule:: expetator.benchmarks.mpibench
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-expetator.benchmarks.npbbench module
-------------------------------------
-
-.. automodule:: expetator.benchmarks.npbbench
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-expetator.benchmarks.percentagebench module
--------------------------------------------
-
-.. automodule:: expetator.benchmarks.percentagebench
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-expetator.benchmarks.sleepbench module
---------------------------------------
-
-.. automodule:: expetator.benchmarks.sleepbench
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-expetator.benchmarks.watermark module
--------------------------------------
-
-.. automodule:: expetator.benchmarks.watermark
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-Module contents
----------------
-
-.. automodule:: expetator.benchmarks
-   :members:
-   :undoc-members:
-   :show-inheritance:

docs/expetator.leverages.rst

 expetator.leverages package
 ===========================
 
-Submodules
-----------
+.. autoclass:: expetator.leverages.dvfs.Dvfs
 
-expetator.leverages.dvfs module
--------------------------------
+.. autoclass:: expetator.leverages.gpuclock.GpuClock
 
-.. automodule:: expetator.leverages.dvfs
-   :members:
-   :undoc-members:
-   :show-inheritance:
+.. autoclass:: expetator.leverages.gpupow.GpuPower
 
-expetator.leverages.gpuclock module
------------------------------------
+.. autoclass:: expetator.leverages.neosched.NeoSched
 
-.. automodule:: expetator.leverages.gpuclock
-   :members:
-   :undoc-members:
-   :show-inheritance:
+.. autoclass:: expetator.leverages.nodeepsleep.Nodeepsleep
 
-expetator.leverages.gpupow module
----------------------------------
+.. autoclass:: expetator.leverages.pct.Pct
 
-.. automodule:: expetator.leverages.gpupow
-   :members:
-   :undoc-members:
-   :show-inheritance:
+.. autoclass:: expetator.leverages.powercap.Powercap
 
-expetator.leverages.neosched module
------------------------------------
+.. autoclass:: expetator.leverages.template.Template
 
-.. automodule:: expetator.leverages.neosched
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-expetator.leverages.nodeepsleep module
---------------------------------------
-
-.. automodule:: expetator.leverages.nodeepsleep
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-expetator.leverages.pct module
-------------------------------
-
-.. automodule:: expetator.leverages.pct
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-expetator.leverages.powercap module
------------------------------------
-
-.. automodule:: expetator.leverages.powercap
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-expetator.leverages.template module
------------------------------------
-
-.. automodule:: expetator.leverages.template
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-Module contents
----------------
-
-.. automodule:: expetator.leverages
-   :members:
-   :undoc-members:
-   :show-inheritance:

docs/expetator.monitors.rst

 expetator.monitors package
 ==========================
 
-Submodules
-----------
+.. autoclass:: expetator.monitors.kwollect.Power
 
-expetator.monitors.kwollect module
-----------------------------------
+.. autoclass:: expetator.monitors.lperf.Lperf
 
-.. automodule:: expetator.monitors.kwollect
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-expetator.monitors.laptop\_power\_monitor module
-------------------------------------------------
-
-.. automodule:: expetator.monitors.laptop_power_monitor
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-expetator.monitors.lperf module
--------------------------------
-
-.. automodule:: expetator.monitors.lperf
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-expetator.monitors.mojitos module
----------------------------------
-
-.. automodule:: expetator.monitors.mojitos
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-expetator.monitors.power module
--------------------------------
-
-.. automodule:: expetator.monitors.power
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-expetator.monitors.powergpu module
-----------------------------------
-
-.. automodule:: expetator.monitors.powergpu
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-Module contents
----------------
-
-.. automodule:: expetator.monitors
-   :members:
-   :undoc-members:
-   :show-inheritance:
+.. autoclass:: expetator.monitors.mojitos.Mojitos
+	       
+.. autoclass:: expetator.monitors.powergpu.Power

docs/expetator.rst

@@ -11,16 +11,8 @@ Subpackages
    expetator.leverages
    expetator.monitors
 
-Submodules
-----------
-
-expetator.add\_energy module
-----------------------------
-
-.. automodule:: expetator.add_energy
-   :members:
-   :undoc-members:
-   :show-inheritance:
+Main modules
+------------
 
 expetator.bundle module
 -----------------------
@@ -30,14 +22,6 @@ expetator.bundle module
    :undoc-members:
    :show-inheritance:
 
-expetator.clean\_csv module
----------------------------
-
-.. automodule:: expetator.clean_csv
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
 expetator.experiment module
 ---------------------------
 
@@ -46,14 +30,6 @@ expetator.experiment module
    :undoc-members:
    :show-inheritance:
 
-expetator.get\_nb\_freq module
-------------------------------
-
-.. automodule:: expetator.get_nb_freq
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
 expetator.monitoring\_csv module
 --------------------------------
 
@@ -94,10 +70,3 @@ expetator.watermark module
    :undoc-members:
    :show-inheritance:
 
-Module contents
----------------
-
-.. automodule:: expetator
-   :members:
-   :undoc-members:
-   :show-inheritance:

docs/index.rst

-.. Expetator documentation master file, created by
-   sphinx-quickstart on Sun May 29 21:31:22 2022.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
-
-Welcome to Expetator's documentation!
-=============================
+Welcome to Expetator's documentation
+=====================================
 
 .. toctree::
-   :maxdepth: 2
-   :caption: Contents:
+   :maxdepth: 4
+
+   expetator.benchmarks
+   expetator.leverages
+   expetator.monitors
 
-   ../README.md
 
-Indices and tables
-==================
+.. include:: ../README.md
+   :parser: myst_parser.sphinx_
 
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`

docs/modules.rst

-expetator
-=========
-
-.. toctree::
-   :maxdepth: 4
-
-   expetator

expetator/leverages/dvfs.py

@@ -21,7 +21,17 @@ def get_dvfs_values():
     return frequencies, pcts
 
 class Dvfs:
-    'Cpufreq based DVFS'
+    """Cpufreq based DVFS
+
+    Detects all available frequencies and go through all of them
+
+    :param dummy: Only uses min and max frequency
+    :type dummy: bool
+    :param baseline: Only uses max frequency
+    :type baseline: bool
+    :param frequencies: Limits to the provided list of frequencies
+    :type frequencies: int list
+    """
     def __init__(self, dummy=False, baseline=False, frequencies=None):
         self.basedir = os.path.dirname(os.path.abspath(__file__))
         self.dummy = dummy
@@ -30,7 +40,7 @@ class Dvfs:
         self.available_frequencies = frequencies
 
     def build(self, executor):
-        'Gather the available Frequenciess'
+        'Gather the available Frequencies'
         self.executor = executor
         self.executor.hosts(self.basedir+'/dvfs_pct.sh init')
         if self.available_frequencies is None: