docs: Add preliminary reference of interface base classes and fix docstrings

Author: mhthies

docs/interfaces.rst

@@ -17,8 +17,10 @@ See the following sections for more information about a specific interface:
 
     interfaces/*
 
+For creating custom SHC interfaces, see the following guideline:
 
-Creating Custom Interfaces
---------------------------
+.. toctree::
+    :maxdepth: 1
+
+    interfaces_custom
 
-TODO

docs/interfaces_custom.rst

@@ -0,0 +1,42 @@
+
+Creating Custom Interfaces
+--------------------------
+
+TODO
+
+
+Interface Base and Helper Classes Reference
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. automodule:: shc.supervisor
+
+    .. autoclass:: AbstractInterface
+        :members:
+
+    .. autoclass:: ServiceStatus
+
+    .. autoclass:: InterfaceStatus
+
+    .. autofunction:: interface_failure
+
+
+.. automodule:: shc.interfaces._helper
+
+    .. autoclass:: ReadableStatusInterface
+
+        .. automethod:: _get_status
+
+    .. autoclass:: SubscribableStatusInterface
+
+    .. autoclass:: SubscribableStatusConnector
+
+        .. automethod:: update_status
+
+    .. autoclass:: SupervisedClientInterface
+
+        .. automethod:: __init__
+        .. automethod:: _connect
+        .. automethod:: _run
+        .. automethod:: _subscribe
+        .. automethod:: _disconnect
+        .. automethod:: wait_running

shc/interfaces/_helper.py

@@ -128,7 +128,6 @@ class SupervisedClientInterface(ReadableStatusInterface, metaclass=abc.ABCMeta):
     implemented in such a way, that it shuts down the run task.
     """
     def __init__(self, auto_reconnect: bool = True, failsafe_start: bool = False):
-        super().__init__()
         """
         :param auto_reconnect: If True (default), the supervisor tries to reconnect the interface automatically with
             exponential backoff (`backoff_base` * `backoff_exponent` ^ n seconds sleep), when `_run` exits unexpectedly
@@ -139,6 +138,7 @@ def __init__(self, auto_reconnect: bool = True, failsafe_start: bool = False):
             backoff (see `auto_reconnect` option). Otherwise (default), the first connection attempt on startup is not
             retried and will raise an exception from `start()` on failure, even if `auto_reconnect` is True.
         """
+        super().__init__()
         self.auto_reconnect = auto_reconnect
         self.failsafe_start = failsafe_start and auto_reconnect
         self.backoff_base = 1.0  #: First wait interval for exponential backoff in seconds

shc/supervisor.py

@@ -50,7 +50,7 @@ class AbstractInterface(metaclass=abc.ABCMeta):
 
     If an interface inherits from this base class, it is automatically registered for startup via :func:`main`.
 
-    :ivar criticality: Defines to which extend the interface's status is considered when determining the overall SHC
+    :ivar criticality: Defines to which extent the interface's status is considered when determining the overall SHC
         system state, e.g. when reporting to a monitoring system or creating alerts in a user interface. A critical
         failure of a *CRITICAL* system is considered a critical state, whereas a critical failure of an *INFO* system
         only triggers an information message.