Avoid warning about multiple graphviz directives#804
Merged
michaeljones merged 2 commits intobreathe-doc:masterfrom Feb 14, 2022
2bndy5:avoid-multi-graphviz-directives
Merged
Avoid warning about multiple graphviz directives#804michaeljones merged 2 commits intobreathe-doc:masterfrom 2bndy5:avoid-multi-graphviz-directives
michaeljones merged 2 commits intobreathe-doc:masterfrom
2bndy5:avoid-multi-graphviz-directives
Conversation
Contributor
Author
|
I've been testing these changes on the same sample project used in #757, but with the |
Contributor
Author
|
This seems to be high priority given the amount of references in #803 I can't think of any other ways/scenarios to test these changes on. Everything looks good and ready for review. Again, I'm very sorry I didn't catch this before v4.33.0 release. |
vermeeren
reviewed
Feb 14, 2022
vermeeren
approved these changes
Feb 14, 2022
This file contains hidden or 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
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 fixes #803 (a priority bug in v4.33.0).
sphinx.ext.graphviz. This was causing a warning in sphinx build logs.graphvizdirective. This is needed to allow users to arbitrarily addbreatheandsphinx.ext.graphvizto the conf.pyextensionslist in whatever order.As stated already in the docs (added in #757), using the dot tool requires that
sphinx.ext.graphvizbe added to theextensionslist in conf.py. Appropriate warnings will get triggered when breathe uses the graphviz directive without addingsphinx.ext.graphvizto theextensionslist.Just to reiterate what is said in the docs:
sphinx.ext.graphvizis required for the\dotand\dotfilecmds.:allow-dot-graphs:(an option fordoxygenclass,doxygenstruct,doxygenfile,doxygenindexautodoxygenfile, andautodoxygenindexdirectives) is required for the doxygen-generated graphs (like include/inheritance/collaboration graphs), sincesphinx.ext.graphvizis required to use the graphviz directive that will render the doxygen-generated graphs. Without specifying:allow-dot-graphs:, the doxygen generated graphs will be ignored (even ifsphinx.ext.graphvizis added to the list of used extensions in conf.py).@gmarull did the right thing by commenting on #757. Otherwise, I would not have been alerted to #803.
Please tag me ( @2bndy5 ) in the future if there are any other problems that arise from the feature introduced by #757. 🤞🏼