Skip to content

Commit a92cefd

Browse files
committed
doc: Render mermaid
1 parent 30919bc commit a92cefd

4 files changed

Lines changed: 5 additions & 3 deletions

File tree

docs/conf.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@
1414
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
1515

1616
extensions = [
17+
'sphinxcontrib.mermaid',
1718
'myst_parser',
1819
'sphinx_copybutton',
1920
'sphinxext.rediraffe',

docs/dataset-lifecycle.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ pass through, and the mutations that drive transitions between them.
1414
A dataset's state is determined by two fields: whether it has any
1515
snapshots and whether it is public.
1616

17-
```mermaid
17+
```{mermaid}
1818
stateDiagram-v2
1919
[*] --> Draft
2020
Draft --> Embargoed : createSnapshot()
@@ -126,7 +126,7 @@ delete.
126126
Snapshots can be independently deprecated without changing the dataset's
127127
state.
128128

129-
```mermaid
129+
```{mermaid}
130130
stateDiagram-v2
131131
[*] --> Active : createSnapshot()
132132
Active --> Deprecated : deprecateSnapshot()

docs/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,7 @@ structure of our package and hosting setup may be interested in the following se
9090
:maxdepth: 1
9191
9292
architecture
93+
dataset-lifecycle
9394
maintenance
9495
Source repository (GitHub) <https://github.com/OpenNeuroOrg/openneuro>
9596
```

docs/specs/2026-04-06-doi-lifecycle-design.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ DataCite defines three DOI states:
7272

7373
### State diagram
7474

75-
```mermaid
75+
```{mermaid}
7676
stateDiagram-v2
7777
[*] --> Draft : createSnapshot()
7878
Draft --> Draft : deprecateSnapshot() / undoDeprecateSnapshot()

0 commit comments

Comments
 (0)