-
Notifications
You must be signed in to change notification settings - Fork 365
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add sphinx-mermaid extension and update userdoc workflow #2603
Add sphinx-mermaid extension and update userdoc workflow #2603
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you, this is really a useful extension.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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! |
Update branch to be up-to-date with master
…-simulator into add-sphinx-mermaid
See new documentation workflow output here |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good!
This PR adds the mermaid extension for Sphinx so sequence diagrams can be build with mermaid syntax.
See kernel.html for example.