draw.io build make target added

.dockerignore

@@ -7,6 +7,8 @@ docs/source/apiref
 docs/source/_misc
 docs/source/release_notes.rst
 docs/source/tutorials
+docs/source/_static/drawio
+docs/source/drawio_src/**/export
 *__pycache__*
 *.idea/*
 .idea/*

.gitattributes

@@ -2,5 +2,6 @@
 *   text=auto
 *.png   binary
 *.jpg   binary
+*.drawio binary
 *.py    text eol=lf
-*.sh    text eol=lf
+*.sh    text eol=lf

.gitignore

@@ -7,6 +7,8 @@ docs/source/apiref
 docs/source/_misc
 docs/source/release_notes.rst
 docs/source/tutorials
+docs/source/_static/drawio
+docs/source/drawio_src/**/export
 *__pycache__*
 *.idea/*
 .idea/*

dff/pipeline/pipeline/actor.py

@@ -16,6 +16,11 @@
 
 Overall, the actor acts as a bridge between the user's input and the dialog graph,
 making sure that the conversation follows the expected flow and providing a personalized experience to the user.
+
+Below you can see a diagram of user request processing with Actor.
+Both `request` and `response` are saved to :py:class:`.Context`.
+
+.. figure:: /_static/drawio/dfe/user_actor.png
 """
 import logging
 from typing import Union, Callable, Optional, Dict, List, Any, ForwardRef

docs/source/drawio_src/dfe/user_actor.drawio

@@ -0,0 +1 @@
+<mxfile scale="20" border="0"><diagram id="JaFah7PjJ86j10p3dxxR" name="Page-1">zVhNk6IwEP01XrZqtwhf4nUcZ/ayJw87c4zQAjWRuCEo7q/fIB0BwRFX0blQ6Zfv1/26U4ys6Sp/FXQd/eIBsJFpBPnIeh6ZpuNa6lsAuxIgrmOXSCjiALEKmMd/AUED0SwOIG0MlJwzGa+boM+TBHzZwKgQfNsctuSsueuahtAC5j5lbfR3HMioRG1iVfhPiMMId3Y87FhRPRYvkkY04NsaZM1G1lRwLsvWKp8CK7jTtJTzXk70Hs4lIJF9JozxGHKnrwaBuimaXMiIhzyhbFahT5FcMdVJVBPyWL6ptvHDQeu9sLD9nNeNnTYSKXZvdeO9WqEwq2l7S89LP0D6EW7sZ2IDARrLmLEpZ1zsb2AtPR98v5ghBf+AWs/Cc2ynWKtNEzKX8kz4yISJgUVFCNqRJVRwVJuG1L4CX4E6sRoggFEZb5rRQjHowsO4yjGqgb7p9hOeZUNZhouOTJepUz0tVCMsGlkKQoNquQPe9jBjSieFJ7dRLGG+pvsbb5VUm96l6boUzzLOC7KPiQ4oeMtOol3fg8Xy2GknWd+AkJB/yij2TsaoJMwc310blbStdEgIZpOopsEDeI0bJv8hl0aoNvg4KyTST0jkMiEdeRFI4MC4y4sTd2xRt69cdPKr68V9lF60s7+GpwZivINw7YT7M26dz1ALVdWKevRSbOVLfu905YAX2F20e+bCct0B0hUxbeeR+cobWgWkpoFKEb1UcKsy7XSogDxKBc55FQj4k0Eqe8W+4FkSHJxxJv4v5/fm4U4soxnu43FHuBtGO9z1g/iqpG+0CLx10r8g3Kt3blWRD6Xi/uXZbcvEfJRK3D4qSdc8UWl/aJn04Hd4mdhdVWEwmZhf6W10SibGZTK5VTXRpaOuk4e9qfRhPhPKN58nKu4GqCcNL9+Q7oueT+ZRPSEdQjE7hGLfQig93rQPYf+amnAN+44xHPvKrH577ftq/w6t2T8=</diagram></mxfile>

makefile

@@ -1,3 +1,5 @@
+.ONESHELL:
+
 SHELL = /bin/bash
 
 PYTHON = python3
@@ -8,6 +10,7 @@ TEST_COVERAGE_THRESHOLD=95
 TEST_ALLOW_SKIP=all  # for more info, see tests/conftest.py
 
 PATH := $(VENV_PATH)/bin:$(PATH)
+PWD := $(shell pwd)
 
 help:
 	@echo "Thanks for your interest in Dialog Flow Framework!"
@@ -62,7 +65,22 @@ test: venv
 test_all: venv wait_db test lint
 .PHONY: test_all
 
-doc: venv clean_docs
+build_drawio:
+	docker run --rm --name="drawio-convert" -v $(PWD)/docs/source/drawio_src:/data rlespinasse/drawio-export -f png --on-changes --remove-page-suffix
+	docker run --rm --name="drawio-chown" -v $(PWD)/docs/source/drawio_src:/data --entrypoint chown rlespinasse/drawio-export -R "$(shell id -u):$(shell id -g)" /data
+	for folder in docs/source/drawio_src/*; do
+		foldername=`basename $${folder}`
+		for file in $${folder}/*; do
+			filename=`basename $${file}`
+			if [[ -d $${file} && $${filename} == "export" ]]; then
+				mkdir -p docs/source/_static/drawio/$${foldername}
+				cp -r $${file}/* docs/source/_static/drawio/$${foldername}
+			fi
+		done
+	done
+.PHONY: build_drawio
+
+doc: venv clean_docs build_drawio
 	python3 docs/source/utils/patching.py
 	sphinx-apidoc -e -E -f -o docs/source/apiref dff
 	sphinx-build -M clean docs/source docs/build
@@ -92,6 +110,8 @@ clean_docs:
 	rm -rf docs/source/apiref
 	rm -rf docs/source/_misc
 	rm -rf docs/source/tutorials
+	rm -rf docs/source/_static/drawio
+	rm -rf docs/source/drawio_src/**/export
 .PHONY: clean_docs
 
 clean: clean_docs