Add support for Mermaid charts to Doxygen #1006
Merged
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.
As per #997, this PR adds support for Mermaid charts in Doxygen. It allows Mermaid charts to be added to the
doc/diagrams
folder and included in comments using the@mermaid{filename}
alias. You can test it out by grabbing some Mermaid code, for example from this bit of their documentation, putting it indoc/diagrams/test.mmd
, and adding a@mermaid{test}
command to any Doxygen comment. After generating the docs, you should see the chart show up where the command was placed.I've put this into a draft PR for the moment because somehow these changes have resulted in the sidebar disappearing. I believe this is a result of modifying Doxygen's footer.html, but I can't tell exactly why it would have this effect. Needs to be fiddled with.
Fixes #997