Skip to content

Commit 7f7b373

Browse files
committed
Prep for new sphinxcontrib-mermaid
1 parent 7db9272 commit 7f7b373

File tree

3 files changed

+38
-7
lines changed

3 files changed

+38
-7
lines changed

docs/src/configuration.md

Lines changed: 35 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -197,39 +197,68 @@ graph TD;
197197
graph TD
198198
A[\Replenish Value Add stock/] --->C
199199
B(Order product with Value Add) --->C
200-
C{Frequent process?} --->|Yes|D
200+
C{Frequent process?} --->|Yes|D
201201
C --->|No|F
202-
D{New template?} --->|Yes|E
202+
D{New template?} --->|Yes|E
203203
D --->|No|G
204204
E(Create work order template) --->G
205205
F(Create work order) --->H
206206
G(Copy template to work order) --->I
207207
H(Add materials to work order processes) --->J
208208
I(Adjust material quantities) --->J
209209
J(Monitor work orders) --->K
210-
K{Material quantities in stock?} --->|No|L
210+
K{Material quantities in stock?} --->|No|L
211211
K --->|Yes|M
212212
L(Procure materials) --->M
213213
M(Change status to In Progress) --->N
214-
N{External Vendor to perform step?} --->|Yes|O
214+
N{External Vendor to perform step?} --->|Yes|O
215215
N --->|No|P
216216
O(Add vendor costs) --->Q
217217
P[\Perform work order step/] --->R
218218
Q([Ship materials to Vendor]) --->S --->X
219-
R{Additional processing required?} --->|Yes|N
219+
R{Additional processing required?} --->|Yes|N
220220
R--->|No|T
221221
S[\Perform work order step/] --->U
222222
T(Receive final stock) --->V
223223
U(Receive product from vendor) --->W
224224
V(Ship product on order) --->Y
225-
W{Partial quantity received?} --->|Yes|X
225+
W{Partial quantity received?} --->|Yes|X
226226
W --->|No|Z
227227
X[Create work order backorder] ---> J
228228
Y(Change status to complete) --->AA
229229
Z(Pay vendor invoice) --->R
230230
AA([Finish])
231231
```
232232

233+
```mermaid
234+
zenuml
235+
title Demo
236+
Alice->John: Hello John, how are you?
237+
John->Alice: Great!
238+
Alice->John: See you later!
239+
```
240+
241+
```mermaid
242+
mindmap
243+
root((mindmap))
244+
Origins
245+
Long history
246+
::icon(fa fa-book)
247+
Popularisation
248+
British popular psychology author Tony Buzan
249+
Research
250+
On effectiveness<br/>and features
251+
On Automatic creation
252+
Uses
253+
Creative techniques
254+
Strategic planning
255+
Argument mapping
256+
Tools
257+
Pen and paper
258+
Mermaid
259+
```
260+
261+
233262
## GitHub Admonitions
234263

235264
GitHub admonitions are automatically translated to sphinx.

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ dependencies = [
3535
"sphinx-autoapi",
3636
"sphinx-copybutton",
3737
"sphinx-design",
38-
"sphinxcontrib-mermaid>=1.1,<2",
38+
"sphinxcontrib-mermaid>=2.0.0rc0,<2.1",
3939
"sphinx-reredirects",
4040
"toml",
4141
"typer",

yardang/conf.py.j2

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,8 @@ nb_execution_excludepatterns = {{nb_execution_excludepatterns}}
8383
#sphinxcontrib.mermaid
8484
mermaid_d3_zoom = True
8585
mermaid_fullscreen = True
86+
mermaid_include_elk = True
87+
mermaid_include_zenuml = True
8688

8789
# redirects
8890
redirects = {{redirects}}

0 commit comments

Comments
 (0)