From 3674dfefe67c272cd8a8d5bc6847c0e75b1b0c99 Mon Sep 17 00:00:00 2001 From: Georges Da Costa <dacosta@irit.fr> Date: Sun, 29 May 2022 21:56:59 +0200 Subject: [PATCH] Another try to use RTD --- docs/expetator.benchmarks.rst | 93 ++++++++++++++++++++++++++++++ docs/expetator.leverages.rst | 77 +++++++++++++++++++++++++ docs/expetator.monitors.rst | 61 ++++++++++++++++++++ docs/expetator.rst | 103 ++++++++++++++++++++++++++++++++++ docs/modules.rst | 7 +++ 5 files changed, 341 insertions(+) create mode 100644 docs/expetator.benchmarks.rst create mode 100644 docs/expetator.leverages.rst create mode 100644 docs/expetator.monitors.rst create mode 100644 docs/expetator.rst create mode 100644 docs/modules.rst diff --git a/docs/expetator.benchmarks.rst b/docs/expetator.benchmarks.rst new file mode 100644 index 0000000..9936a6e --- /dev/null +++ b/docs/expetator.benchmarks.rst @@ -0,0 +1,93 @@ +expetator.benchmarks package +============================ + +Submodules +---------- + +expetator.benchmarks.genericbench module +---------------------------------------- + +.. automodule:: expetator.benchmarks.genericbench + :members: + :undoc-members: + :show-inheritance: + +expetator.benchmarks.gpucpubench module +--------------------------------------- + +.. automodule:: expetator.benchmarks.gpucpubench + :members: + :undoc-members: + :show-inheritance: + +expetator.benchmarks.gpumembench module +--------------------------------------- + +.. automodule:: expetator.benchmarks.gpumembench + :members: + :undoc-members: + :show-inheritance: + +expetator.benchmarks.gromacsbench module +---------------------------------------- + +.. automodule:: expetator.benchmarks.gromacsbench + :members: + :undoc-members: + :show-inheritance: + +expetator.benchmarks.membench module +------------------------------------ + +.. automodule:: expetator.benchmarks.membench + :members: + :undoc-members: + :show-inheritance: + +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: diff --git a/docs/expetator.leverages.rst b/docs/expetator.leverages.rst new file mode 100644 index 0000000..9445651 --- /dev/null +++ b/docs/expetator.leverages.rst @@ -0,0 +1,77 @@ +expetator.leverages package +=========================== + +Submodules +---------- + +expetator.leverages.dvfs module +------------------------------- + +.. automodule:: expetator.leverages.dvfs + :members: + :undoc-members: + :show-inheritance: + +expetator.leverages.gpuclock module +----------------------------------- + +.. automodule:: expetator.leverages.gpuclock + :members: + :undoc-members: + :show-inheritance: + +expetator.leverages.gpupow module +--------------------------------- + +.. automodule:: expetator.leverages.gpupow + :members: + :undoc-members: + :show-inheritance: + +expetator.leverages.neosched module +----------------------------------- + +.. 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: diff --git a/docs/expetator.monitors.rst b/docs/expetator.monitors.rst new file mode 100644 index 0000000..b3235cb --- /dev/null +++ b/docs/expetator.monitors.rst @@ -0,0 +1,61 @@ +expetator.monitors package +========================== + +Submodules +---------- + +expetator.monitors.kwollect module +---------------------------------- + +.. 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: diff --git a/docs/expetator.rst b/docs/expetator.rst new file mode 100644 index 0000000..d597df8 --- /dev/null +++ b/docs/expetator.rst @@ -0,0 +1,103 @@ +expetator package +================= + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + expetator.benchmarks + expetator.leverages + expetator.monitors + +Submodules +---------- + +expetator.add\_energy module +---------------------------- + +.. automodule:: expetator.add_energy + :members: + :undoc-members: + :show-inheritance: + +expetator.bundle module +----------------------- + +.. automodule:: expetator.bundle + :members: + :undoc-members: + :show-inheritance: + +expetator.clean\_csv module +--------------------------- + +.. automodule:: expetator.clean_csv + :members: + :undoc-members: + :show-inheritance: + +expetator.experiment module +--------------------------- + +.. automodule:: expetator.experiment + :members: + :undoc-members: + :show-inheritance: + +expetator.get\_nb\_freq module +------------------------------ + +.. automodule:: expetator.get_nb_freq + :members: + :undoc-members: + :show-inheritance: + +expetator.monitoring\_csv module +-------------------------------- + +.. automodule:: expetator.monitoring_csv + :members: + :undoc-members: + :show-inheritance: + +expetator.monitoring\_list module +--------------------------------- + +.. automodule:: expetator.monitoring_list + :members: + :undoc-members: + :show-inheritance: + +expetator.remove\_watermark module +---------------------------------- + +.. automodule:: expetator.remove_watermark + :members: + :undoc-members: + :show-inheritance: + +expetator.tools module +---------------------- + +.. automodule:: expetator.tools + :members: + :undoc-members: + :show-inheritance: + +expetator.watermark module +-------------------------- + +.. automodule:: expetator.watermark + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: expetator + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/modules.rst b/docs/modules.rst new file mode 100644 index 0000000..acb8a59 --- /dev/null +++ b/docs/modules.rst @@ -0,0 +1,7 @@ +expetator +========= + +.. toctree:: + :maxdepth: 4 + + expetator -- GitLab