Docs/mermaid #974
Open
Docs/mermaid #974
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…d beneftis and smart functionality pages Signed-off-by: Nicolas Höning <nicolas@seita.nl>
… in my eyes) and rework it throughout (adding Docker steps in paralell) Signed-off-by: Nicolas Höning <nicolas@seita.nl>
Signed-off-by: Nicolas Höning <nicolas@seita.nl>
Signed-off-by: Nicolas Höning <nicolas@seita.nl>
Signed-off-by: Nicolas Höning <nicolas@seita.nl>
Signed-off-by: Nicolas Höning <nicolas@seita.nl>
Signed-off-by: Nicolas Höning <nicolas@seita.nl>
Signed-off-by: Nicolas Höning <nicolas@seita.nl>
Signed-off-by: Nicolas Höning <nicolas@seita.nl>
Signed-off-by: Nicolas Höning <nicolas@seita.nl>
Signed-off-by: Nicolas Höning <nicolas@seita.nl>
Signed-off-by: Nicolas Höning <nicolas@seita.nl>
Signed-off-by: Nicolas Höning <nicolas@seita.nl>
…V2G/flex-model illustration to tutorials Signed-off-by: Nicolas Höning <nicolas@seita.nl>
Signed-off-by: Nicolas Höning <nicolas@seita.nl>
Signed-off-by: Nicolas Höning <nicolas@seita.nl>
Signed-off-by: Nicolas Höning <nicolas@seita.nl>
Signed-off-by: Nicolas Höning <nicolas@seita.nl>
…ome docs didn't have the 'Or' in there Signed-off-by: Nicolas Höning <nicolas@seita.nl>
Signed-off-by: F.N. Claessen <felix@seita.nl>
Signed-off-by: Nicolas Höning <nicolas@seita.nl>
…/flexmeasures into docs/refactoring-scheduling
Signed-off-by: Nicolas Höning <nicolas@seita.nl>
9 tasks
|
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? |
Signed-off-by: Nicolas Höning <nicolas@seita.nl>
Signed-off-by: Nicolas Höning <nicolas@seita.nl>
|
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. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
In #953 (see #953 (comment)) 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-docsand 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.