aboutsummaryrefslogtreecommitdiff
path: root/doc/prototype.rst
diff options
context:
space:
mode:
authorSander Vrijders <sander.vrijders@ugent.be>2018-03-29 16:24:52 +0200
committerSander Vrijders <sander.vrijders@ugent.be>2018-03-29 16:46:18 +0200
commit41a0fce2b047dacc0e67972ca058c194caa1a51c (patch)
tree9645ffbef5ff898ba38ef30728bcb537c7b0a267 /doc/prototype.rst
parentc1ad42adc854604e0023a01633976cb3d26b9244 (diff)
downloadrumba-41a0fce2b047dacc0e67972ca058c194caa1a51c.tar.gz
rumba-41a0fce2b047dacc0e67972ca058c194caa1a51c.zip
doc: Reorganize documentation
This reorganizes the documentation somewhat to be more tutorial-styled.
Diffstat (limited to 'doc/prototype.rst')
-rw-r--r--doc/prototype.rst8
1 files changed, 8 insertions, 0 deletions
diff --git a/doc/prototype.rst b/doc/prototype.rst
index 13b4547..a827dcb 100644
--- a/doc/prototype.rst
+++ b/doc/prototype.rst
@@ -1,6 +1,14 @@
Prototype plugins
-------------------------
+Rumba provides a generic Experiment class that specific protoypes can
+derive from. All prototypes have to re-implement the functions
+provided by the base class.
+
+.. autoclass:: rumba.model.Experiment
+
+Specific implementations of the Testbed class:
+
.. toctree::
irati
rlite