From b1526fa247f36c341118880be524fc41ae48ca19 Mon Sep 17 00:00:00 2001 From: manuel83 Date: Mon, 28 Jan 2019 00:00:05 +0100 Subject: [PATCH] bug fixing --- docs_src/source/actor.rst | 14 +------------- docs_src/source/conf.py | 4 +++- docs_src/source/standards.rst | 7 ++++--- docs_src/source/webapis.rst | 2 ++ 4 files changed, 10 insertions(+), 17 deletions(-) diff --git a/docs_src/source/actor.rst b/docs_src/source/actor.rst index 04d9fc0..9f43ac0 100644 --- a/docs_src/source/actor.rst +++ b/docs_src/source/actor.rst @@ -8,6 +8,7 @@ Architecture .. image:: picture.jpeg :scale: 50% + ActorController ^^^^^^^^^^^^^^^ @@ -44,16 +45,3 @@ config.yaml :language: yaml :linenos: -.. mermaid:: - - sequenceDiagram - participant Alice - participant Bob - Alice->John: Hello John, how are you? - loop Healthcheck - John->John: Fight against hypochondria - end - Note right of John: Rational thoughts
prevail... - John-->Alice: Great! - John->Bob: How about you? - Bob-->John: Jolly good! \ No newline at end of file diff --git a/docs_src/source/conf.py b/docs_src/source/conf.py index 8c92510..e7dcfec 100644 --- a/docs_src/source/conf.py +++ b/docs_src/source/conf.py @@ -40,7 +40,9 @@ release = '4.0' # ones. extensions = [ 'sphinx.ext.autodoc', - 'sphinxcontrib.mermaid' + 'sphinxcontrib.mermaid', + 'sphinxcontrib.blockdiag', + 'sphinxcontrib.swaggerdoc' ] # Add any paths that contain templates here, relative to this directory. diff --git a/docs_src/source/standards.rst b/docs_src/source/standards.rst index c905e67..cc87ac5 100644 --- a/docs_src/source/standards.rst +++ b/docs_src/source/standards.rst @@ -10,7 +10,7 @@ As a main framework CraftBeerPi is based on `aiohttp` * aioHTTP https://aiohttp.readthedocs.io/en/stable/ CBPiEventBus --------- +------------ One core concept of CraftBeerPi 4.x is the CBPiEventBus. It should be avoided to call method on a controller directly. Events should be fired and listener methods should be used. @@ -34,7 +34,8 @@ Here an example how listen on an event. .. note:: - It's imporante to add **kwargs as parameter to the listening method. This makes sure that maybe addtional event paramenter are not causing an exception. + It is important to add **kwargs as parameter to the listening method. This makes sure that maybe addtional event paramenter are not causing an exception. + A list of all registered events listeners can be found under: `http://:/system/events` @@ -59,7 +60,7 @@ Typically you perform just some basing parameter validation and fire an event so CBPiWebSocket ---------- +------------- The CBPiWebSocket is listening on `http://:/ws` All events are forwarded to all connected web socket clients. diff --git a/docs_src/source/webapis.rst b/docs_src/source/webapis.rst index 3509033..961e6a2 100644 --- a/docs_src/source/webapis.rst +++ b/docs_src/source/webapis.rst @@ -8,6 +8,8 @@ After startup of the server the API documentation is available under: http://:/api/doc +.. swaggerv2doc:: http://0.0.0.0:8080/api/doc/swagger.json + WebSocket API =============