Update documentation of the simulaqron.settings package

dieriver · dieriver · commit ab1f263be0b1 · 2026-01-15T19:55:36.000+01:00
diff --git a/docs/simulaqron.general.rst b/docs/simulaqron.general.rst
@@ -14,7 +14,7 @@ simulaqron.general.host_config module
 
 
 simulaqron.general.errors module
--------------------------------------
+--------------------------------
 
 .. automodule:: simulaqron.general.errors
     :members:
diff --git a/docs/simulaqron.netqasm_backend.rst b/docs/simulaqron.netqasm_backend.rst
@@ -5,23 +5,23 @@ Submodules
 ----------
 
 simulaqron.netqasm_backend.executioner module
--------------------------
+---------------------------------------------
 
 .. automodule:: simulaqron.netqasm_backend.executioner
     :members:
     :undoc-members:
     :show-inheritance:
 
 simulaqron.netqasm_backend.factory module
--------------------------
+-----------------------------------------
 
 .. automodule:: simulaqron.netqasm_backend.factory
     :members:
     :undoc-members:
     :show-inheritance:
 
 simulaqron.netqasm_backend.qnodeos module
--------------------------
+-----------------------------------------
 
 .. automodule:: simulaqron.netqasm_backend.qnodeos
     :members:
diff --git a/docs/simulaqron.rst b/docs/simulaqron.rst
@@ -20,15 +20,15 @@ Submodules
 ----------
 
 simulaqron.cli module
-----------------------------
+---------------------
 
 .. automodule:: simulaqron.cli
     :members:
     :undoc-members:
     :show-inheritance:
 
 simulaqron.math module
---------------------------
+----------------------
 
 .. automodule:: simulaqron.math
     :members:
@@ -52,7 +52,7 @@ simulaqron.reactor module
     :show-inheritance:
 
 simulaqron.sim_util module
--------------------------
+--------------------------
 
 .. automodule:: simulaqron.sim_util
     :members:
diff --git a/docs/simulaqron.sdk.rst b/docs/simulaqron.sdk.rst
@@ -5,23 +5,23 @@ Submodules
 ----------
 
 simulaqron.sdk.broadcast_channel module
--------------------------
+---------------------------------------
 
 .. automodule:: simulaqron.sdk.broadcast_channel
     :members:
     :undoc-members:
     :show-inheritance:
 
 simulaqron.sdk.connection module
--------------------------
+--------------------------------
 
 .. automodule:: simulaqron.sdk.connection
     :members:
     :undoc-members:
     :show-inheritance:
 
 simulaqron.sdk.socket module
--------------------------
+----------------------------
 
 .. automodule:: simulaqron.sdk.socket
     :members:
diff --git a/docs/simulaqron.settings.rst b/docs/simulaqron.settings.rst
@@ -1,15 +1,21 @@
 simulaqron.settings package
-======================
-
-.. warning:: UPDATE THIS STRUCTURE!
+===========================
 
 Submodules
 ----------
 
-simulaqron.run.run module
--------------------------
+simulaqron.settings.network module
+----------------------------------
+
+.. automodule:: simulaqron.settings.network
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+simulaqron.settings.simulaqron_config module
+--------------------------------------------
 
-.. automodule:: simulaqron.run.run
+.. automodule:: simulaqron.settings.simulaqron_config
     :members:
     :undoc-members:
     :show-inheritance:
diff --git a/simulaqron/settings/network_config.py b/simulaqron/settings/network_config.py
diff --git a/simulaqron/settings/simulaqron_config.py b/simulaqron/settings/simulaqron_config.py
