Merge pull request #142 from dmitry-sinina/mermaid

migrate from mscgen to mermaid
yeti-switch · Sep 18, 2024 · 0c86297 · 0c86297
2 parents 3b54e5b + 7b61beb
commit 0c86297
Show file tree

Hide file tree

Showing 19 changed files with 134 additions and 693 deletions.
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -12,7 +12,7 @@ jobs:
       - uses: actions/checkout@v2
 
       - name: install sphinx
-        run: pip install sphinx sphinx_rtd_theme
+        run: pip install sphinx sphinx_rtd_theme sphinxcontrib-mermaid
 
       - name: install graphviz and rclone
         run: sudo apt install graphviz rclone

diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -11,7 +11,7 @@ jobs:
     steps:
       - uses: actions/checkout@v2
       - name: install sphinx
-        run: pip install sphinx sphinx_rtd_theme
+        run: pip install sphinx sphinx_rtd_theme sphinxcontrib-mermaid
 
       - name: install graphviz
         run: sudo apt install graphviz

diff --git a/_static/js/mscgen-inpage.js b/_static/js/mscgen-inpage.js
diff --git a/en/conf.py b/en/conf.py
@@ -29,7 +29,7 @@
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = ["sphinx.ext.graphviz", "sphinx.ext.mathjax"]
+extensions = ["sphinx.ext.graphviz", "sphinx.ext.mathjax", "sphinxcontrib.mermaid"]
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]
@@ -299,3 +299,4 @@
     "github_version": 'master',
     "conf_py_path": '/en/'
 }
+
diff --git a/en/index.rst b/en/index.rst
@@ -22,6 +22,7 @@ Welcome to Yeti's documentation!
    monitoring.rst
    database-tuning.rst
    data-retention/index.rst
+   load-balancer.rst
 
 .. toctree::
    :maxdepth: 2

diff --git a/en/installation/installation-1.10/index.rst b/en/installation/installation-1.10/index.rst
@@ -17,7 +17,6 @@ Components:
    redis
    management
    sems
-   load-balancer
    call-trace
    cdr-export
    database-tuning

diff --git a/en/installation/installation-1.10/load-balancer.rst b/en/installation/installation-1.10/load-balancer.rst
diff --git a/en/installation/installation-1.11/index.rst b/en/installation/installation-1.11/index.rst
@@ -16,7 +16,6 @@ Components:
    web
    redis
    sems
-   load-balancer
    call-trace
    cdr-export
    release-notes

diff --git a/en/installation/installation-1.11/load-balancer.rst b/en/installation/installation-1.11/load-balancer.rst
diff --git a/en/installation/installation-1.12/index.rst b/en/installation/installation-1.12/index.rst
@@ -16,7 +16,6 @@ Components:
    web
    redis
    sems
-   load-balancer
    release-notes
    upgrade-from-1.11
 
diff --git a/en/installation/installation-1.12/load-balancer.rst b/en/installation/installation-1.12/load-balancer.rst
diff --git a/en/installation/installation-1.7/index.rst b/en/installation/installation-1.7/index.rst
@@ -17,7 +17,6 @@ Components:
    redis
    management
    sems
-   load-balancer
    call-trace
    cli-utility
    database-tuning