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.
Based on #775 it turns out that they way Breathe uses
add_directive
is not strictly adhering to the interface: the argument must be a class derived fromdocutils.parsers.rst.Directive
(https://www.sphinx-doc.org/en/master/extdev/appapi.html#sphinx.application.Sphinx.add_directive).This was not done because the Breathe directives needs access to some objects created during setup-time.
This PR uses a different hax: use
env.temp_data
to smuggle in those objects, and set them every time a new document is processed, via thesource-read
event. Thereby the directives can be added directly.It's still ugly but I haven't found a prettier way to do it.
References: