Merge commit '655eefc07db57c1d21cbf11487876c7d8ad6dc11'

[nepi.git] / doc / sphinx / index.rst

diff --git a/doc/sphinx/index.rst b/doc/sphinx/index.rst
new file mode 100644 (file)
index 0000000..6cc4c83
--- /dev/null
+++ b/doc/sphinx/index.rst
@@ -0,0 +1,91 @@
+.. Nepi documentation master file, created by
+   sphinx-quickstart on Tue Mar 26 11:36:35 2013.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+NEPI modules 
+============
+
+This page documents the NEPI source code. It presents the NEPI core modules, the Platform resource modules (i.e. drivers to manage platforms), and other miscellaneous classes.
+
+Core modules
+------------
+
+  * ExperimentController API
+
+    * :mod:`ExperimentController <nepi.execution.ec>`
+
+  * ResourceManager API
+
+    * :mod:`ResourceManager <nepi.execution.resource>`
+  
+  * Attribute module
+    
+    * :mod:`Attribute <nepi.execution.attribute>`
+  
+  * Trace module
+    
+    * :mod:`Trace <nepi.execution.trace>`
+  
+  * Runner module
+
+    * :mod:`ExperimentRunner <nepi.execution.runner>`
+  
+  * Scheduler module
+
+    * :mod:`Scheduler <nepi.execution.scheduler>`
+
+
+
+Platform modules
+----------------
+
+  * Live Experiments
+
+    * Linux testbeds
+
+      * :mod:`Linux <nepi.resources.linux>`
+
+    * PlanetLab testbeds
+ 
+      * :mod:`PlanetLab <nepi.resources.planetlab>`
+
+    * OMF testbed
+
+      * :mod:`OMF <nepi.resources.omf>`
+
+  * Simulated Experiments
+
+    * ns-3 simulator
+
+      * :mod:`ns-3 <nepi.resources.ns3>`    
+
+      * :mod:`ns-3 in Linux hosts <nepi.resources.linux.ns3>`    
+  
+  * Emulated Experiments
+
+    * DCE emulation extension
+
+      * :mod:`DCE Application <nepi.resources.ns3.ns3dceapplication>`    
+
+      * :mod:`DCE Linux Application <nepi.resources.linux.ns3.ns3dceapplication>`    
+    
+    * NetNS emulator
+
+      * :mod:`NetNS <nepi.resources.netns>`    
+
+Miscellaneous modules
+---------------------
+
+      * :mod:`Util <nepi.util>`    
+
+.. toctree::
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+