Move to mermaid from plantUML.

lsst-ts · May 21, 2024 · 29f3e99 · 29f3e99
1 parent 95f856c
commit 29f3e99
Show file tree

Hide file tree

Showing 4 changed files with 14 additions and 16 deletions.
diff --git a/doc/conf.py b/doc/conf.py
@@ -3,8 +3,6 @@
 This configuration only affects single-package Sphinx documentation builds.
 """
 
-import os
-
 import lsst.ts.imsim  # noqa
 from documenteer.conf.pipelinespkg import *  # noqa
 
@@ -15,13 +13,8 @@
 doxylink = {}
 
 
-# Support the sphinx extension of plantuml
-extensions.append("sphinxcontrib.plantuml")  # noqa
-
-# Put the path to plantuml.jar
-plantuml_path = (
-    os.path.expanduser("~/plantuml.jar")
-    if os.getenv("PATH_PLANTUML") is None
-    else os.getenv("PATH_PLANTUML")
-)
-plantuml = f"java -jar {plantuml_path}"
+# Support the sphinx extension of mermaid
+extensions = [
+    "sphinxcontrib.mermaid",
+    "sphinx_automodapi.automodapi",
+]
diff --git a/doc/developer-guide/developer-guide.rst b/doc/developer-guide/developer-guide.rst
@@ -27,7 +27,7 @@ imsim
 
 This module contains the closed loop methods.
 
-.. uml:: ../uml/imsimClass.uml
+.. mermaid:: ../uml/imsimClass.mmd
     :caption: Class diagram of ts_imsim.
 
 * **ClosedLoopTask**: Run the imSim based closed loop for AOS.

diff --git a/doc/uml/imsimClass.uml → doc/uml/imsimClass.mmd b/doc/uml/imsimClass.uml → doc/uml/imsimClass.mmd
@@ -1,5 +1,5 @@
-@startuml
-package "ts_ofc" #DDDDDD {
+classDiagram
+namespace ts_ofc {
   class OFCCalculation
 }
 
@@ -10,4 +10,3 @@ CloseLoopTask o-- OpdMetrology
 CloseLoopTask *-- ObsMetadata
 ImsimCmpt *-- ObsMetadata
 ImsimCmpt o-- OpdMetrology
-@enduml
diff --git a/doc/versionHistory.rst b/doc/versionHistory.rst
@@ -5,6 +5,12 @@
 ##################
 Version History
 ##################
+-------------
+1.5.5
+-------------
+
+* Move class diagrams to mermaid from plantUML.
+
 -------------
 1.5.4
 -------------