diff --git a/.github/workflows/documentation.yaml b/.github/workflows/documentation.yaml index fe0bb2d..4ff8406 100644 --- a/.github/workflows/documentation.yaml +++ b/.github/workflows/documentation.yaml @@ -4,6 +4,7 @@ on: push: branches: - main + - docs/timeline-etc pull_request: types: [reopened, opened, synchronize] @@ -12,7 +13,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..d24b672 100644 --- a/documentations/index.rst +++ b/documentations/index.rst @@ -4,6 +4,11 @@ Transparenzregister Dokumentation ================================= This is the documentation for the AKI project group on the german transparenzregister and an Analysis there of. +.. drawio-figure:: project_management/Arch.-Planning.drawio + :format: png + + An example diagram + .. include:: ../README.md :parser: myst_parser.sphinx_ .. include:: ../CONTRIBUTING.md 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"