flexmeasures icon indicating copy to clipboard operation
flexmeasures copied to clipboard

Published 20 hours ago • verified publisher icon FlexMeasures

Docs/mermaid

Open nhoening opened this issue 1 year ago • 2 comments

Description

In #953 (see https://github.com/FlexMeasures/flexmeasures/pull/953#discussion_r1479405353) we saw we would like to start using Mermaid in our docs.

I have tried that, following the instructions at https://github.com/mgaitan/sphinxcontrib-mermaid, but I could not get mermaid to build anything (yes, I ran pip install sphinxcontrib-mermaid, and I also tried the simple example diagram from their website).

Look & Feel

Running make update-docs and then going to Concepts -> The FlexMeasures Data Model should show a diagram.

How to test

In addition to the local test above, this should also work on ReadTheDocs.

nhoening avatar Feb 08 '24 15:02 nhoening

The current PR description suggests a tech spike with a negative outcome. What's the next decision to be taken to advance the state of this PR?

Flix6x avatar Mar 11 '24 09:03 Flix6x

I don't know. Maybe someone has a bit of knowledge of mermaid and/or Sphinx and wants to pick this up. It would be nice to use mermaid diagrams in our docs, but not a blocker.

nhoening avatar Mar 11 '24 17:03 nhoening