add autodocs for modules

.gitlab-ci.yml

@@ -6,6 +6,7 @@ test:
 docs:
     image: tk0miya/sphinx-html
     script:
+        - python3 setup.py install --user
         - sphinx-build -b html -d _build/doctrees . _build/html
         - eval $(ssh-agent)
         - echo "$SSHKEY" | ssh-add -

ebpfcat/devices.py

+"""\
+A collection of devices
+=======================
+
+This modules contains a collection of devices which may be helpful
+in many projects.
+"""
 from .ebpfcat import Device, FastSyncGroup, TerminalVar, DeviceVar
 
 
 class AnalogInput(Device):
+    """Generic analog input device
+
+    This device can be linked to an analog input of a terminal.
+    It will read from there and return the result in its
+    parameter `value`.
+    """
     value = DeviceVar()
     data = TerminalVar()
 
@@ -16,6 +29,11 @@ class AnalogInput(Device):
 
 
 class AnalogOutput(Device):
+    """Generic analog output device
+
+    This device can be linked to an analog output of a terminal.
+    It will write the `value` to that terminal.
+    """
     value = DeviceVar()
     data = TerminalVar()
 

ebpfcat/ethercat.rst

@@ -92,3 +92,10 @@ The communication with the terminals can happen in three different ways:
 - fast: the data is sent, received and processed using XDP in the Linux
   Kernel. Only very limited operations can be done, but the loop cycle
   frequency exceeds 10 kHz.
+
+
+.. automodule:: ebpfcat.devices
+   :members:
+
+.. automodule:: ebpfcat.ethercat
+   :members: