0.31.0 (#237)

.flake8

@@ -27,3 +27,4 @@ exclude =
     # the interfaces will throw unused imports
     src/HABApp/openhab/interface.py,
     src/HABApp/openhab/interface_async.py,
+    src/HABApp/rule/interfaces/http_interface.py,

_doc/advanced_usage.rst

@@ -191,7 +191,7 @@ Examples:
 
 Add an openhab mock item to the item registry
 
-.. execute_code::
+.. exec_code::
    :hide_output:
 
    import HABApp
@@ -202,15 +202,14 @@ Add an openhab mock item to the item registry
 
 Remove the mock item from the registry
 
-.. execute_code::
+.. exec_code::
    :hide_output:
 
-   # hide
+    # ------------ hide: start ------------
    import HABApp
    from HABApp.openhab.items import SwitchItem
    HABApp.core.Items.add_item(SwitchItem('my_switch', 'ON'))
-   # hide
-
+    # ------------ hide: stop -------------
 
    HABApp.core.Items.pop_item('my_switch')
 
@@ -219,7 +218,7 @@ Note that there are some item methods that encapsulate communication with openha
 These currently do not work with the mock items. The state has to be changed like
 any internal item.
 
-.. execute_code::
+.. exec_code::
    :hide_output:
 
    import HABApp

_doc/asyncio.rst

@@ -17,9 +17,9 @@ Async http calls are available through the ``self.async_http`` object in rule in
 Functions
 ^^^^^^^^^^^^^^^^^^^^^^^^
 
-.. autoclass:: HABApp.rule.interfaces.AsyncHttpConnection
+.. automodule:: HABApp.rule.interfaces.http
    :members:
-
+   :imported-members:
 
 Examples
 ^^^^^^^^^^^^^^^^^^^^^^^^

_doc/conf.py

@@ -14,14 +14,11 @@
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 #
 import os
-import pathlib
 import sys
 
 # required for autodoc
 sys.path.insert(0, os.path.join(os.path.abspath('..'), 'src'))
 
-sys.path.insert(0, os.path.abspath('./_plugins'))
-
 # -- Project information -----------------------------------------------------
 
 project = 'HABApp'
@@ -35,7 +32,7 @@
 try:
     from HABApp import __version__
     version = __version__
-    print(f'Building doc for {version}')
+    print(f'Building docs for {version}')
 except Exception as e:
     print('Exception', e)
     version = 'dev'
@@ -52,7 +49,7 @@
 extensions = [
     'sphinx.ext.autodoc',
     'sphinx_autodoc_typehints',
-    'sphinx_execute_code',
+    'sphinx_exec_code',
     'sphinx.ext.inheritance_diagram',
 ]
 
@@ -203,9 +200,8 @@
 epub_exclude_files = ['search.html']
 
 # -- Extension configuration -------------------------------------------------
-
-execute_code_working_dir = pathlib.Path(__file__).parent.parent / 'src'
-assert execute_code_working_dir.is_dir(), execute_code_working_dir
+exec_code_working_dir = '../src'
+exec_code_folders = ['../src', '../tests']
 
 autodoc_member_order = 'bysource'
 autoclass_content = 'both'