From 9ce0c93954a6f03563e8c2c822f6fccaec580c64 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Mose=20M=C3=BCller?= <mosemueller@gmail.com>
Date: Thu, 25 Jul 2024 16:37:41 +0200
Subject: [PATCH] adds swagger-ui-tag python dep to render swagger ui, updates
 mkdocs to include new page

---
 mkdocs.yml     |  4 +++-
 poetry.lock    | 48 +++++++++++++++++++++++++++++++++++++++++++++++-
 pyproject.toml |  1 +
 3 files changed, 51 insertions(+), 2 deletions(-)

diff --git a/mkdocs.yml b/mkdocs.yml
index 4b1d504..53450e3 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -4,8 +4,9 @@ edit_uri: blob/docs/docs/
 nav:
   - Home: index.md
   - Getting Started: getting-started.md
-  - User Guide: 
+  - User Guide:
     - Components Guide: user-guide/Components.md
+    - Interacting with Services: user-guide/Interaction.md
   - Developer Guide: 
     - Developer Guide: dev-guide/README.md
     - API Reference: dev-guide/api.md
@@ -37,6 +38,7 @@ plugins:
   - include-markdown
   - search
   - mkdocstrings
+  - swagger-ui-tag
 
 watch:
   - src/pydase
diff --git a/poetry.lock b/poetry.lock
index c329080..d1aea50 100644
--- a/poetry.lock
+++ b/poetry.lock
@@ -178,6 +178,27 @@ tests = ["attrs[tests-no-zope]", "zope-interface"]
 tests-mypy = ["mypy (>=1.6)", "pytest-mypy-plugins"]
 tests-no-zope = ["attrs[tests-mypy]", "cloudpickle", "hypothesis", "pympler", "pytest (>=4.3.0)", "pytest-xdist[psutil]"]
 
+[[package]]
+name = "beautifulsoup4"
+version = "4.12.3"
+description = "Screen-scraping library"
+optional = false
+python-versions = ">=3.6.0"
+files = [
+    {file = "beautifulsoup4-4.12.3-py3-none-any.whl", hash = "sha256:b80878c9f40111313e55da8ba20bdba06d8fa3969fc68304167741bbf9e082ed"},
+    {file = "beautifulsoup4-4.12.3.tar.gz", hash = "sha256:74e3d1928edc070d21748185c46e3fb33490f22f52a3addee9aee0f4f7781051"},
+]
+
+[package.dependencies]
+soupsieve = ">1.2"
+
+[package.extras]
+cchardet = ["cchardet"]
+chardet = ["chardet"]
+charset-normalizer = ["charset-normalizer"]
+html5lib = ["html5lib"]
+lxml = ["lxml"]
+
 [[package]]
 name = "bidict"
 version = "0.23.1"
@@ -1089,6 +1110,20 @@ files = [
 dev = ["bump2version (==1.0.1)", "mkdocs (==1.4.0)", "pre-commit", "pytest (==7.1.3)", "pytest-cov (==3.0.0)", "tox"]
 test = ["mkdocs (==1.4.0)", "pytest (==7.1.3)", "pytest-cov (==3.0.0)"]
 
+[[package]]
+name = "mkdocs-swagger-ui-tag"
+version = "0.6.10"
+description = "A MkDocs plugin supports for add Swagger UI in page."
+optional = false
+python-versions = "*"
+files = [
+    {file = "mkdocs-swagger-ui-tag-0.6.10.tar.gz", hash = "sha256:811d55e0905bfecc5f2e743b5b1e4d03b663707d5472984cc7b21f45117dcb29"},
+    {file = "mkdocs_swagger_ui_tag-0.6.10-py3-none-any.whl", hash = "sha256:839373498a42202b3824068064919ad6ddf2e98d5a8deed7d4132719221c0528"},
+]
+
+[package.dependencies]
+beautifulsoup4 = ">=4.11.1"
+
 [[package]]
 name = "mkdocstrings"
 version = "0.22.0"
@@ -1978,6 +2013,17 @@ files = [
     {file = "six-1.16.0.tar.gz", hash = "sha256:1e61c37477a1626458e36f7b1d82aa5c9b094fa4802892072e49de9c60c4c926"},
 ]
 
+[[package]]
+name = "soupsieve"
+version = "2.5"
+description = "A modern CSS selector implementation for Beautiful Soup."
+optional = false
+python-versions = ">=3.8"
+files = [
+    {file = "soupsieve-2.5-py3-none-any.whl", hash = "sha256:eaa337ff55a1579b6549dc679565eac1e3d000563bcb1c8ab0d0fefbc0c2cdc7"},
+    {file = "soupsieve-2.5.tar.gz", hash = "sha256:5663d5a7b3bfaeee0bc4372e7fc48f9cff4940b3eec54a6451cc5299f1097690"},
+]
+
 [[package]]
 name = "toml"
 version = "0.10.2"
@@ -2219,4 +2265,4 @@ multidict = ">=4.0"
 [metadata]
 lock-version = "2.0"
 python-versions = "^3.10"
-content-hash = "704ee6c0507dbbd884f3c9e3d8648d087732092e115d3adbf58e89405b31e5f2"
+content-hash = "3f397396c238541d7a07327c9b289843124d8d4dd6b1d96a3393f3be2be38fa4"
diff --git a/pyproject.toml b/pyproject.toml
index 53833c9..ec52d97 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -41,6 +41,7 @@ mkdocs = "^1.5.2"
 mkdocs-include-markdown-plugin = "^3.9.1"
 mkdocstrings = "^0.22.0"
 pymdown-extensions = "^10.1"
+mkdocs-swagger-ui-tag = "^0.6.10"
 
 [build-system]
 requires = ["poetry-core"]