Documentation upgrade

doc/source/index.rst

@@ -12,7 +12,7 @@ Welcome to the Purple Dome documentation!
 =========================================
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 3
    :caption: Contents:
 
    basics/background
@@ -25,13 +25,13 @@ Welcome to the Purple Dome documentation!
 
    usage/cli
 
-   extending/vulnerability_plugins.rst
+   extending/vulnerability_plugins
 
    extending/attack_plugins
 
    extending/sensor_plugins
 
-   extending/vm_controller_plugins.rst
+   extending/vm_controller_plugins
 
    extending/extending
 

doc/source/usage/cli.rst

@@ -4,35 +4,37 @@ CLI
 
 There are three command line tools that offer a simple interface to PurpleDome.
 
-Experiment control
-------------------
-
-Experiment control is the core tool to run an experiment. It accepts a yaml config file and runs the experiments in there. The configuration file defines the system to be used (together with a Vagrant file being referenced there) and the attacks to run.
+The central one is Experiment control where you start your experiments:
 
 .. asciinema:: ./../asciinema/experiment_control.cast
     :speed: 2
 
+Experiment control
+==================
+
+Experiment control is the core tool to run an experiment. It accepts a yaml config file and runs the experiments in there. The configuration file defines the system to be used (together with a Vagrant file being referenced there) and the attacks to run.
+
 .. argparse::
     :filename: ../experiment_control.py
     :func: create_parser
     :prog: ./experiment_control.py
 
-Caldera control
----------------
+Machine control
+===============
 
-Directly control a caldera server
+Directly control the machines
 
 .. argparse::
-    :filename: ../caldera_control.py
+    :filename: ../machine_control.py
     :func: create_parser
-    :prog: ./caldera_control.py
+    :prog: ./machine_control.py
 
-Machine control
----------------
+Caldera control
+===============
 
-Directly control the machines
+Directly control a caldera server
 
 .. argparse::
-    :filename: ../machine_control.py
+    :filename: ../caldera_control.py
     :func: create_parser
-    :prog: ./machine_control.py
+    :prog: ./caldera_control.py

requirements.txt

@@ -9,6 +9,6 @@ sphinx-pyreverse==0.0.13
 coverage==5.4
 PyYAML==5.4.1
 straight.plugin==1.5.0
-sphinxcontrib.asciinema==0.3.1
+sphinxcontrib.asciinema==0.3.2
 paramiko==2.7.2
 pymetasploit3==1.0.3