docs: switch to local plantuml rendering (#3304)

SwissDataScienceCenter · Oct 19, 2023 · 27acb1f · 27acb1f
1 parent d3aa69f
commit 27acb1f
Show file tree

Hide file tree

Showing 6 changed files with 13 additions and 6 deletions.
diff --git a/.github/workflows/pull-request-test.yml b/.github/workflows/pull-request-test.yml
@@ -19,6 +19,10 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
+      - uses: actions/setup-java@v3
+        with:
+          distribution: 'temurin'
+          java-version: '17'
       - uses: actions/setup-python@v4
         with:
           python-version: 3.9

diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -1,10 +1,11 @@
 version: 2
 build:
-  os: ubuntu-20.04
+  os: ubuntu-22.04
   tools:
     python: "3.9"
   apt_packages:
     - "graphviz"
+    - "default-jdk"
 sphinx:
   configuration: docs/conf.py
 

diff --git a/docs/conf.py b/docs/conf.py
@@ -33,7 +33,7 @@
 # ones.
 extensions = [
     "cheatsheet",
-    "plantweb.directive",
+    "sphinxcontrib.plantuml",
     "sphinx_click",
     "sphinx_copybutton",
     "sphinx_rtd_theme",
@@ -51,7 +51,9 @@
     "sphinx_design",
 ]
 
-# Plantweb configuration
+# Plantuml configuration
+local_plantuml_path = os.path.join(os.path.dirname(__file__), "utils", "plantuml-asl-1.2023.11.jar")
+plantuml = f"java -Djava.awt.headless=true -jar {local_plantuml_path}"
 plantweb_defaults = {"format": "svg"}
 
 # Add any paths that contain templates here, relative to this directory.

diff --git a/docs/reference/services/services-architecture.rst b/docs/reference/services/services-architecture.rst
@@ -62,9 +62,9 @@ System Context
 
     Person(logged_in, "Logged-In user")
     Person(cli, "Renku CLI", $sprite="bash")
-    System(renku, "", $link="../reference/services/services-architecture.html#container-diagram", $sprite="img:https://renku.readthedocs.io/en/add-architecture-diagram/_static/icons/renku_logo.png{scale=0.2}")
+    System(renku, "", $link="../reference/services/services-architecture.html#container-diagram", $sprite="img:https://renku.readthedocs.io/en/latest/_static/icons/renku_logo.png{scale=0.2}")
     System(gitlab, "Gitlab", $sprite="gitlab")
-    System(keycloak, "Keycloak", $sprite="img:https://renku.readthedocs.io/en/add-architecture-diagram/_static/icons/keycloak_logofinal_1color.png{scale=0.2}")
+    System(keycloak, "Keycloak", $sprite="img:https://renku.readthedocs.io/en/latest/_static/icons/keycloak_logofinal_1color.png{scale=0.2}")
     System(k8s, "Kubernetes", $sprite="kubernetes")
     SystemDb(s3, "S3")
     SystemDb(azure_blob, "Azure Blob")

diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1,4 +1,4 @@
-plantweb==1.2.1
+sphinxcontrib-plantuml==0.26
 sphinx>=4.1
 sphinxcontrib-mermaid==0.9.2
 sphinxcontrib-napoleon==0.7

diff --git a/docs/utils/plantuml-asl-1.2023.11.jar b/docs/utils/plantuml-asl-1.2023.11.jar