feat: add mermaid

vberlier · Aug 9, 2022 · 2979d61 · 2979d61
1 parent 14cf661
commit 2979d61
Show file tree

Hide file tree

Showing 6 changed files with 38 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -41,6 +41,7 @@ Mudkip enables the following Sphinx extensions:
 - [`sphinx.ext.githubpages`](https://www.sphinx-doc.org/en/master/usage/extensions/githubpages.html) when deploying to GitHub Pages
 - [`myst_parser`](https://myst-parser.readthedocs.io/en/latest/) for markdown support
 - [`myst_nb`](https://myst-nb.readthedocs.io/en/latest/) for Jupyter notebook support
+- [`sphinxcontrib.mermaid`](https://github.com/mgaitan/sphinxcontrib-mermaid) for [Mermaid](https://mermaid-js.github.io/mermaid/) graphs and flowcharts
 
 ## Installation
 

diff --git a/docs/index.md b/docs/index.md
@@ -6,6 +6,7 @@ A friendly Sphinx wrapper.
 :hidden:
 
 notebook_example
+mermaid_example
 changelog
 ```
 

diff --git a/docs/mermaid_example.md b/docs/mermaid_example.md
@@ -0,0 +1,23 @@
+# Mermaid example
+
+```{mermaid}
+graph TD;
+  A-->B;
+  A-->C;
+  B-->D;
+  C-->D;
+```
+
+```{mermaid}
+sequenceDiagram
+  participant Alice
+  participant Bob
+  Alice->>John: Hello John, how are you?
+  loop Healthcheck
+    John->>John: Fight against hypochondria
+  end
+  Note right of John: Rational thoughts <br/>prevail!
+  John-->>Alice: Great!
+  John->>Bob: How about you?
+  Bob-->>John: Jolly good!
+```
diff --git a/mudkip/application.py b/mudkip/application.py
@@ -160,6 +160,8 @@ def create_sphinx_application(self):
             "intersphinx_mapping", {"python": ("https://docs.python.org/3", None)}
         )
 
+        extensions.append("sphinxcontrib.mermaid")
+
         extensions.append("mudkip.extension")
 
         self.sphinx = Sphinx(

diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -32,6 +32,7 @@ jupyter-nbextensions-configurator = "^0.5.0"
 colorama = {version = "*", markers = 'sys_platform == "win32"'}
 myst-nb = "^0.16.0"
 furo = "^2022.6.21"
+sphinxcontrib-mermaid = "^0.7.1"
 
 [tool.poetry.dev-dependencies]
 black = "^22.6.0"