Merge pull request #244 from SoftwareQuTech/master

Update Develop after hot-fix

Author: Axel Dahlberg

.travis.yml

@@ -19,11 +19,6 @@ matrix:
       osx_image: xcode10.2
       language: shell
 before_install:
-  - git clone --branch Develop https://github.com/SoftwareQuTech/CQC-Python
-  - cd CQC-Python
-  - make build
-  - pip3 install dist/*.whl
-  - cd ..
   - make build
 install:
   - pip3 install dist/*.whl

docs/ConfNodes.rst

@@ -196,15 +196,23 @@ Starting a network from Python
 
 You can also start a network within a Python script (this is in fact what simulaqron does), by using the class :code:`simulaqron.network.Network`. To setup a network by name "test" with the nodes Alice, Bob and Charlie, where Bob is connected with Alice and Charlie but Alice and Charlie are not connected use the following code code::
 
-    from simulaqron.network import Network
+   from simulaqron.network import Network
 
-    # Setup the network
-    nodes = ["Alice", "Bob", "Charlie"]
-    topology = {"Alice": ["Bob"], "Bob": ["Alice", "Charlie"], "Charlie": ["Bob"]}
-    network = Network(name="test", nodes=nodes, topology=topology)
 
-    # Start the network
-    network.start()
+   def main():
+       # Setup the network
+       nodes = ["Alice", "Bob", "Charlie"]
+       topology = {"Alice": ["Bob"], "Bob": ["Alice", "Charlie"], "Charlie": ["Bob"]}
+       network = Network(name="test", nodes=nodes, topology=topology)
+
+       # Start the network
+       network.start()
+
+       input("To stop the network, press enter...")
+
+
+   if __name__ == '__main__':
+       main()
 
 By default the method :code:`simulaqron.network.Network.start`, only returns when the network is running, i.e. all the connections are established. To avoid this use the argument :code:`wait_until_running=False`.
 

docs/conf.py

@@ -30,7 +30,13 @@
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = ["sphinx.ext.autodoc", "sphinx.ext.todo", "sphinx.ext.viewcode", "sphinx.ext.mathjax"]
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinx.ext.todo",
+    "sphinx.ext.viewcode",
+    "sphinx.ext.mathjax",
+    "sphinx.ext.githubpages",
+]
 
 mathjax_path = "https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"