aboutsummaryrefslogtreecommitdiff
path: root/doc/model.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/model.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/model.rst')
-rw-r--r--doc/model.rst26
1 files changed, 22 insertions, 4 deletions
diff --git a/doc/model.rst b/doc/model.rst
index b487263..1ced817 100644
--- a/doc/model.rst
+++ b/doc/model.rst
@@ -1,5 +1,23 @@
-Model
-=============
+Defining the recursive network
+==============================
-.. automodule:: rumba.model
- :member-order: bysource
+Experimenters can define their recursive network by using the building
+blocks listed below.
+
+.. autoclass:: rumba.model.Node
+
+.. autoclass:: rumba.model.DIF
+
+.. autoclass:: rumba.model.NormalDIF
+
+.. autoclass:: rumba.model.ShimUDPDIF
+
+.. autoclass:: rumba.model.ShimEthDIF
+
+.. autoclass:: rumba.model.Distribution
+
+.. autoclass:: rumba.model.Delay
+
+.. autoclass:: rumba.model.Loss
+
+.. autoclass:: rumba.model.LinkQuality