diff options
| author | Sander Vrijders <sander.vrijders@ugent.be> | 2018-03-26 16:25:14 +0200 |
|---|---|---|
| committer | Sander Vrijders <sander.vrijders@ugent.be> | 2018-03-28 16:41:40 +0200 |
| commit | a1bddf0ab2cd7bee30b1f0dc1575c0b8c532e157 (patch) | |
| tree | 65172a461889ca93053187494a565423a54f112e /doc/utils.rst | |
| parent | a95c3b376053ed00f0e7184dbd228598a9aaf50f (diff) | |
| download | rumba-a1bddf0ab2cd7bee30b1f0dc1575c0b8c532e157.tar.gz rumba-a1bddf0ab2cd7bee30b1f0dc1575c0b8c532e157.zip | |
rumba: Add Rumba documentation website
This adds a documentation website for Rumba which is triggered
automatically after changes to master.
Diffstat (limited to 'doc/utils.rst')
| -rw-r--r-- | doc/utils.rst | 13 |
1 files changed, 13 insertions, 0 deletions
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() |