From a1bddf0ab2cd7bee30b1f0dc1575c0b8c532e157 Mon Sep 17 00:00:00 2001
From: Sander Vrijders <sander.vrijders@ugent.be>
Date: Mon, 26 Mar 2018 16:25:14 +0200
Subject: rumba: Add Rumba documentation website

This adds a documentation website for Rumba which is triggered
automatically after changes to master.
---
 doc/utils.rst | 13 +++++++++++++
 1 file changed, 13 insertions(+)
 create mode 100644 doc/utils.rst

(limited to 'doc/utils.rst')

diff --git a/doc/utils.rst b/doc/utils.rst
new file mode 100644
index 0000000..6df8a0c
--- /dev/null
+++ b/doc/utils.rst
@@ -0,0 +1,13 @@
+Utils
+=============
+
+.. autoclass:: rumba.utils.ExperimentManager
+   :member-order: bysource
+
+Example usage of the class:
+
+.. code-block:: python
+
+   with ExperimentManager(exp, swap_out_strategy=PROMPT_SWAPOUT):
+       exp.swap_in()
+       exp.bootstrap_prototype()
-- 
cgit v1.2.3