From 3a1621142eba9080a1fee77861a8400562afe04e Mon Sep 17 00:00:00 2001
From: Georges Da Costa <dacosta@irit.fr>
Date: Mon, 13 Jun 2022 09:29:04 +0200
Subject: [PATCH] Improves the documentation
---
docs/expetator.rst | 72 ++++++----------------------------------------
1 file changed, 9 insertions(+), 63 deletions(-)
diff --git a/docs/expetator.rst b/docs/expetator.rst
index 90373b1..334953b 100644
--- a/docs/expetator.rst
+++ b/docs/expetator.rst
@@ -1,72 +1,18 @@
-expetator package
-=================
+Expetator
+=========
-Subpackages
------------
-
-.. toctree::
- :maxdepth: 4
-
- expetator.benchmarks
- expetator.leverages
- expetator.monitors
-
-Main modules
-------------
-
-expetator.bundle module
------------------------
-
-.. automodule:: expetator.bundle
- :members:
- :undoc-members:
- :show-inheritance:
-
-expetator.experiment module
----------------------------
+Starting an experiment
+----------------------
.. automodule:: expetator.experiment
- :members:
- :undoc-members:
- :show-inheritance:
+ :members: run_experiment
-expetator.monitoring\_csv module
---------------------------------
+Interaction with the platform
+-----------------------------
-.. automodule:: expetator.monitoring_csv
+.. autoclass:: expetator.experiment.Executor
: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:
+
--
GitLab