Make debug config variables available in conf.py #533
Merged
Conversation
This file contains 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
breathe_debug_trace_directives = False breathe_debug_trace_doxygen_ids = False breathe_debug_trace_qualification = False
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.
In order to make debugging easier #512 added some variables for debug output. This PR makes them formal config variables so users can create more descriptive logs.
breathe_debug_trace_directives = False: the main variable that will print out the domain directives that Breathe runs, indented to indicate the scoping.breathe_debug_trace_doxygen_ids = False: write some information about the Doxygen IDs that Breathe attaches to the declarations in order for inline references to be resolved. This can for example be used to get information for the remaining part of Duplicate IDs when using INLINE_INHERITED_MEMBERS=YES #356.breathe_debug_trace_qualification = False: when a Breathe directive has found the entity to document, it may be nested somewhere inside the Doxygen XML. In order to construct the correct Sphinx directive it needs to figure out how the XML nesting translates into scope nesting. This variable prints out information about this process.