diff --git a/.github/workflows/documentation.yaml b/.github/workflows/documentation.yaml index fe0bb2d..abd7c5b 100644 --- a/.github/workflows/documentation.yaml +++ b/.github/workflows/documentation.yaml @@ -12,7 +12,10 @@ jobs: name: Build runs-on: ubuntu-latest steps: - - run: sudo apt install pandoc -y + - name: Install prio to running the process + run: | + sudo apt install pandoc snapd -y + sudo snap install drawio - uses: actions/checkout@v3 - name: Setup Python uses: actions/setup-python@v4 diff --git a/documentations/conf.py b/documentations/conf.py index e23b762..e1cece0 100644 --- a/documentations/conf.py +++ b/documentations/conf.py @@ -44,6 +44,7 @@ extensions: Final[list[str]] = [ "IPython.sphinxext.ipython_console_highlighting", "sphinxcontrib.mermaid", "notfound.extension", + "sphinxcontrib.drawio", ] # templates_path : Final[list[str]] = ["_templates"] diff --git a/documentations/index.rst b/documentations/index.rst index 0057ae7..b932acb 100644 --- a/documentations/index.rst +++ b/documentations/index.rst @@ -4,6 +4,26 @@ Transparenzregister Dokumentation ================================= This is the documentation for the AKI project group on the german transparenzregister and an Analysis there of. +On the 9th September 2023 the following current development state has been determined: + +.. drawio-figure:: project_management/Arch.-Planning.drawio + :format: png + :page-index: 1 + +The target deployment architecture should look as follows: + +.. drawio-figure:: project_management/Arch.-Planning.drawio + :format: png + :page-index: 2 + +The timeline to reach this goal is: + +.. drawio-figure:: project_management/Arch.-Planning.drawio + :format: png + :page-index: 3 + + An example diagram + .. include:: ../README.md :parser: myst_parser.sphinx_ .. include:: ../CONTRIBUTING.md diff --git a/documentations/project_management/Arch.-Planning.drawio b/documentations/project_management/Arch.-Planning.drawio new file mode 100644 index 0000000..4125687 --- /dev/null +++ b/documentations/project_management/Arch.-Planning.drawio @@ -0,0 +1,1065 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/poetry.lock b/poetry.lock index e9fedd0..b317719 100644 --- a/poetry.lock +++ b/poetry.lock @@ -5128,6 +5128,20 @@ Sphinx = ">=5" lint = ["docutils-stubs", "flake8", "mypy"] test = ["pytest"] +[[package]] +name = "sphinxcontrib-drawio" +version = "0.0.16" +description = "Sphinx Extension to include draw.io files" +optional = false +python-versions = ">=3.6" +files = [ + {file = "sphinxcontrib-drawio-0.0.16.tar.gz", hash = "sha256:2ae85d34f8ebfe66ccc4dbc779bff5ae486c0853a68fc024c1075c54358c8513"}, + {file = "sphinxcontrib_drawio-0.0.16-py3-none-any.whl", hash = "sha256:b043f75c463d527a823cd0cb418b23b49ebad96f00b3f471102524cbf3d8841c"}, +] + +[package.dependencies] +sphinx = ">=2" + [[package]] name = "sphinxcontrib-htmlhelp" version = "2.0.4" @@ -5558,13 +5572,13 @@ files = [ [[package]] name = "types-requests" -version = "2.31.0.4" +version = "2.31.0.5" description = "Typing stubs for requests" optional = false python-versions = "*" files = [ - {file = "types-requests-2.31.0.4.tar.gz", hash = "sha256:a111041148d7e04bf100c476bc4db3ee6b0a1cd0b4018777f6a660b1c4f1318d"}, - {file = "types_requests-2.31.0.4-py3-none-any.whl", hash = "sha256:c7a9d6b62776f21b169a94a0e9d2dfcae62fa9149f53594ff791c3ae67325490"}, + {file = "types-requests-2.31.0.5.tar.gz", hash = "sha256:e4153c2a4e48dcc661600fa5f199b483cdcbd21965de0b5e2df26e93343c0f57"}, + {file = "types_requests-2.31.0.5-py3-none-any.whl", hash = "sha256:e2523825754b2832e04cdc1e731423390e731457890113a201ebca8ad9b40427"}, ] [package.dependencies] @@ -5824,4 +5838,4 @@ web-server = ["dash", "dash-auth", "dash-bootstrap-components", "matplotlib", "s [metadata] lock-version = "2.0" python-versions = "^3.11" -content-hash = "e6a72339834d20e81bd534e754e23ffe9427f69da658195060e5a671fbfb5cbe" +content-hash = "1d21c3be46cb84d7e1bb356735528c06e00f5d635897f22744d65e8781a87d4f" diff --git a/pyproject.toml b/pyproject.toml index 9b3d6b6..1f68ddb 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -75,6 +75,7 @@ sphinx-copybutton = "^0.5.2" sphinx-notfound-page = "^1.0.0" sphinx-rtd-theme = "^1.3.0" sphinx_autodoc_typehints = "*" +sphinxcontrib-drawio = "^0.0.16" sphinxcontrib-mermaid = "^0.9.2" sphinxcontrib-napoleon = "^0.7"