Updates

.vscode/settings.json

@@ -1,5 +1,5 @@
 {
-    "python.pythonPath": "/usr/local/bin/python",
+    "python.pythonPath": "/usr/local/bin/python3",
     "python.linting.enabled": true,
     "python.linting.pylintEnabled": false,
     "python.linting.pydocstyleEnabled": false,

sphinx-docs/conf.py

@@ -32,7 +32,8 @@
 # ones.
 extensions = [
     'sphinx.ext.napoleon',
-    'sphinx.ext.githubpages'
+    'sphinx.ext.githubpages',
+    'sphinx.ext.autosummary'
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -62,3 +63,12 @@
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
 html_static_path = ['_static']
+
+latex_elements = {
+  'extraclassoptions': 'openany,oneside'
+}
+
+autodoc_member_order = 'bysource'
+
+autodoc_default_flags = ['members']
+autosummary_generate = True

sphinx-docs/index.rst

@@ -1,19 +1,22 @@
-.. async gcode client documentation master file, created by
-   sphinx-quickstart on Wed Jan 29 21:45:27 2020.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
-
 Welcome to async gcode client's documentation!
 ==============================================
 
 .. toctree::
-   :maxdepth: 2
-   :caption: Contents:
+   :maxdepth: 3
+   :caption: Inhoud:
 
 
-.. autoclass:: asyncgcodecli.uarm.UArm
+class GCodeResult
+==================
+
+.. autoclass:: asyncgcodecli.driver.GCodeResult
     :members:
 
+class UArm
+==================
+
+.. autoclass:: asyncgcodecli.uarm.UArm
+    :members:
 
 
 Indices and tables
@@ -22,3 +25,4 @@ Indices and tables
 * :ref:`genindex`
 * :ref:`modindex`
 * :ref:`search`
+

tests/test1.py

@@ -6,7 +6,6 @@
 async def move_script(uarm: UArm):
     """Move robot arm script."""
 
-    """Beweeg de robotarm in een cool patroon."""
     # set de robot arm op mode 0 (pomp)
     uarm.set_mode(0)