Add sphinx-mermaid extension and update userdoc workflow #2603
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
jessica-mitchell
added
T: Enhancement
jessica-mitchell
requested review from
JanVogelsang
and removed request for
med-ayssar
JanVogelsang
approved these changes
Mar 2, 2023
There was a problem hiding this comment.
Steffen's comment sounds plausible (also after taking a quick look at the spinx-mermaid installation guide), apart from that this is a nice addition that I hope we can use a lot to make the usually boring technical documentation much more visual, as an example.
|
Pull request automatically marked stale! |
github-actions
bot
added
the
stale
Update branch to be up-to-date with master
jessica-mitchell
removed
the
stale
…-simulator into add-sphinx-mermaid
jessica-mitchell
removed
the
I: User Interface
|
See new documentation workflow output here |
jessica-mitchell
changed the title
jessica-mitchell
requested review from
steffengraber
and removed request for
terhorstd
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.
This PR adds the mermaid extension for Sphinx so sequence diagrams can be build with mermaid syntax.
See kernel.html for example.