add doc for module config

Author: dorianim

docs/index.rst

@@ -32,3 +32,4 @@ Particularly, some `appliances (Proxmox, XCP-ng and KVM) are prepared <https://d
 
    python/shares.rst
    python/computer.rst
+   python/config.rst

docs/python/computer.rst

@@ -0,0 +1,9 @@
+Module: computer
+****************
+
+This module is used to deal with all things related to the computer.
+
+Members
+=======
+.. automodule:: linuxmusterLinuxclient7.computer
+   :members:

docs/python/config.rst

@@ -0,0 +1,11 @@
+Module: config
+**************
+
+This module is used to deal with all config files:
+
+* `/etc/linuxmusterLinuxclient7/network.conf`
+
+Members
+=======
+.. automodule:: linuxmusterLinuxclient7.config
+   :members:

usr/lib/python3/dist-packages/linuxmusterLinuxclient7/config.py

@@ -2,12 +2,18 @@
 from linuxmusterLinuxclient7 import logging, constants
 
 def network():
+    """
+    Get the network configuration in `/etc/linuxmusterLinuxclient7/network.conf`
+
+    :return: Tuple (success, dict of keys)
+    :rtype: tuple
+    """
     rc, rawNetworkConfig = _readNetworkConfig()
     if not rc:
-        return False
+        return False, None
 
     if not _checkNetworkConfigVersion(rawNetworkConfig)[0]:
-        return False
+        return False, None
 
     networkConfig = {}
 
@@ -23,6 +29,14 @@ def network():
     return True, networkConfig
 
 def writeNetworkConfig(newNetworkConfig):
+    """
+    Write the network configuration in `/etc/linuxmusterLinuxclient7/network.conf`
+
+    :param newNetworkConfig: The new config
+    :type newNetworkConfig: dict
+    :return: True or False
+    :rtype: bool
+    """
     networkConfig = configparser.ConfigParser(interpolation=None)
 
     try:
@@ -49,6 +63,13 @@ def writeNetworkConfig(newNetworkConfig):
     return True
 
 def upgrade():
+    """
+    Upgrade the format of the network configuration in `/etc/linuxmusterLinuxclient7/network.conf`
+    This is done automatically on package upgrades.
+
+    :return: True or False
+    :rtype: bool
+    """
     return _upgradeNetworkConfig()
 
 # --------------------