From 0b82eadc6e949f564bbb4835a2f8a0a25893e7dc Mon Sep 17 00:00:00 2001
From: Sander Vrijders <sander.vrijders@ugent.be>
Date: Thu, 5 Apr 2018 09:42:45 +0200
Subject: doc: Update docs with feedback from Miguel
This updates the docs with some feedback from Miguel. It should help
make the documentation easier to follow.
---
doc/conf.py | 2 +-
doc/installation.rst | 14 ++++++++++++++
doc/workflow.rst | 24 ++++++++++++------------
3 files changed, 27 insertions(+), 13 deletions(-)
diff --git a/doc/conf.py b/doc/conf.py
index 4ae4ea4..1a73e44 100644
--- a/doc/conf.py
+++ b/doc/conf.py
@@ -1,7 +1,7 @@
from datetime import datetime
html_theme = "sphinx_rtd_theme"
-extensions = []
+extensions = ['sphinx.ext.viewcode']
project = 'Rumba'
year = datetime.now().year
diff --git a/doc/installation.rst b/doc/installation.rst
index c2038d0..1507cee 100644
--- a/doc/installation.rst
+++ b/doc/installation.rst
@@ -19,3 +19,17 @@ To install the latest version from source, clone the repository and
install it from the command line: ::
$ python setup.py install
+
+Generating the documentation
+---------------------------------
+
+To generate the documentation, run the following command in the root
+folder of the repository: ::
+
+ $ sphinx-build doc/ public/
+
+This will generate HTML pages in the public/ folder. Other output
+formats are possible by using a different 'builder', the following
+command would for instance generate LaTeX files: ::
+
+ $ sphinx-build -b latex doc/ latex/
diff --git a/doc/workflow.rst b/doc/workflow.rst
index 95f68c2..d0e56a7 100644
--- a/doc/workflow.rst
+++ b/doc/workflow.rst
@@ -12,24 +12,24 @@ Workflow
(Ouroboros, rlite, IRATI), passing the testbed instance and a list
of Node instances.
- 1. At the end of the base Experiment constructor, the
- generate function is called to generate information about
- per-node IPCPs, registrations and enrollment, ready to be
- used by the prototype plugins.
+ * At the end of the base Experiment constructor, the
+ generate function is called to generate information about
+ per-node IPCPs, registrations and enrollment, ready to be
+ used by the prototype plugins.
4. Call methods on the prototype.Experiment instance:
- 1. swap_in() swaps the experiment in on the testbed, and fills in
- the missing information in the model.
+ * swap_in() swaps the experiment in on the testbed, and fills in
+ the missing information in the model.
- 2. install_prototype() installs the chosen prototype on the testbed
- (if necessary). Currently an Ubuntu image is assumed.
+ * install_prototype() installs the chosen prototype on the testbed
+ (if necessary). Currently an Ubuntu image is assumed.
- 3. bootstrap_prototype() calls a prototype-specific setup function,
- to create the required IPCPs, perform registrations,
- enrollments, etc.
+ * bootstrap_prototype() calls a prototype-specific setup function,
+ to create the required IPCPs, perform registrations,
+ enrollments, etc.
- 4. swap_out() swaps the experiment out of the testbed.
+ * swap_out() swaps the experiment out of the testbed.
5. Optionally run a Storyboard to emulate real network traffic.
--
cgit v1.2.3