Skip to content

Commit 2c6a01c

Browse files
authored
docs(rtd): fix myst config and unbracket mermaid fenced code blocks (#2288)
Followup to #2287 in view of mgaitan/sphinxcontrib-mermaid#175
1 parent 0339d59 commit 2c6a01c

File tree

2 files changed

+5
-4
lines changed

2 files changed

+5
-4
lines changed

.build_rtd_docs/conf.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -184,9 +184,10 @@
184184
"sphinxcontrib.mermaid",
185185
]
186186

187+
myst_fence_as_directive = ["mermaid"]
188+
187189
# # Tell sphinx what the pygments highlight language should be.
188190
# highlight_language = 'fortran'
189-
190191
source_suffix = {".rst": "restructuredtext", ".md": "markdown"}
191192

192193
# Add any paths that contain templates here, relative to this directory.

src/Solution/ParticleTracker/mf6_6_0_prt_migration_guide.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -133,7 +133,7 @@ Diagrams use the following conventions.
133133
* Green outcome boxes indicate the particle remains active.
134134
* Red outcome boxes indicate the particle terminates.
135135

136-
```{mermaid}
136+
```mermaid
137137
flowchart LR
138138
OPTION[Outcome]
139139
OPTION(OPTION) ==> |Yes| STEP([Step])
@@ -158,7 +158,7 @@ If the cell into which the particle is being released is active, the particle wi
158158

159159
Note that for a dry-but-active cell the `DRAPE` option has no effect. In that case, the particle is released into the cell, and its subsequent behavior can be configured using the `DRY_TRACKING_METHOD` option discussed below.
160160

161-
```{mermaid}
161+
```mermaid
162162
flowchart LR
163163
ACTIVE --> |No| DRAPE(DRAPE)
164164
ACTIVE{Cell active?} --> |Yes| RELEASE[Release in specified cell]:::release
@@ -189,7 +189,7 @@ If `STOP` is selected, dry particles will be terminated.
189189

190190
If `STAY` is selected, a dry particle will remain stationary until a) the water table rises and tracking can continue, b) the particle terminates due to reaching its `STOPTIME` or `STOPTRAVELTIME`, or c) the simulation ends.
191191

192-
```{mermaid}
192+
```mermaid
193193
flowchart LR
194194
ACTIVE{Cell active?} --> |No| TERMINATE{Terminate}
195195
ACTIVE{Cell active?} --> |Yes| PARTICLE_DRY

0 commit comments

Comments
 (0)