Closed YooSunYoung closed 8 months ago
I wanted to use mermaid
instead of png file, but the docs build didn't work as expected...
I'm not sure why...
Here is the mermaid graph I wrote:
stateDiagram
direction TB
Step0: Starting Experiment
Step1: Setting up Measurement Strategy
Step0 --> Step1
state ECDC {
Step2: Data Readout from Detectors
}
Step1 --> ECDC
state SCIPP {
Step3.0: TOA to TOF
}
ECDC --> SCIPP
state DIALS {
direction LR
Step3.1: 1. Spot Finding
Step3.2: 2. TOF to &lambda
Step3.3: 3. Indexing
Step3.4: 4. Refine Indexing
Step3.5: 5. Spot Integration
Step3.1 --> Step3.2
Step3.2 --> Step3.3
Step3.3 --> Step3.4
Step3.4 --> Step3.5
}
SCIPP --> DIALS
state pyscale: pyscale {
Step3.6: Scaling (temporarily using LSCALE)
}
DIALS --> pyscale
state CCP4 {
direction LR
Step3.7: Merging, AIMLESS
Step3.8: I to SFs
Step3.7 --> Step3.8
}
pyscale --> CCP4
state PHENIX {
direction LR
Step4.0: Phasing
Step4.0 --> Step4.1
state MODELCOMPLETED {
state refine <<choice>>
state map <<choice>>
Step4.1: Model Completion
Step4.2: Refinement
Step4.3: MapCalculation
Step4.4: Done
Step4.1 --> Step4.2
Step4.2 --> refine
refine --> Step4.4
refine --> Step4.3
Step4.3 --> map
map --> Step4.4
map --> Step4.1
}
}
CCP4 --> PHENIX
Step5: Finished Experiment
PHENIX --> Step5
Mermaid should work according to https://github.com/mgaitan/sphinxcontrib-mermaid?tab=readme-ov-file#markdown-support.
Mermaid should work according to https://github.com/mgaitan/sphinxcontrib-mermaid?tab=readme-ov-file#markdown-support.
Yeah... but whenever I build the docs, it keeps showing up as a raw text or a raw code-snippet... Is there any other projects using mermaid in the docs?
@Justin-Bergmann just approved after reviewing with me in person ...! Can anyone @scipp/ess-maintainers review this please..? :D Then I'll release it...!
And Justin said he'll send the latex code for the diagram. I'll update them later once I have it.
Fixes #22 Fixes #40