Avoid warning about multiple graphviz directives #804
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.
This PR fixes #803 (a priority bug in v4.33.0).
sphinx.ext.graphviz
. This was causing a warning in sphinx build logs.graphviz
directive. This is needed to allow users to arbitrarily addbreathe
andsphinx.ext.graphviz
to the conf.pyextensions
list in whatever order.As stated already in the docs (added in #757), using the dot tool requires that
sphinx.ext.graphviz
be added to theextensions
list in conf.py. Appropriate warnings will get triggered when breathe uses the graphviz directive without addingsphinx.ext.graphviz
to theextensions
list.Just to reiterate what is said in the docs:
sphinx.ext.graphviz
is required for the\dot
and\dotfile
cmds.:allow-dot-graphs:
(an option fordoxygenclass
,doxygenstruct
,doxygenfile
,doxygenindex
autodoxygenfile
, andautodoxygenindex
directives) is required for the doxygen-generated graphs (like include/inheritance/collaboration graphs), sincesphinx.ext.graphviz
is 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.graphviz
is 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. 🤞🏼