Multiple improvements to the documentation generation #159
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
Add $BUILD/doc/Doxyfile (the Doxygen config file override created from doc/Doxyfile.in) as a dependency of the Doxygen XML generation. This change will ensure Doxygen is run again if its configuration has changed.
Sphinx uses a cache to make the generation faster. However, if a change is made to the source code documentation (e.g. in a comment), Sphinx won't detect it and won't rebuild the documentation. Prevent Sphinx from using its cache to prevent out-of-date documentation.
Breathe doesn't recognize Doxygen's `@ref` annotations, meaning every `@ref` symbol is ignored and no hyperlink is created in the documentation. Instead, enable Doxygen's autolink feature so `symbol()` can be used to link to a symbol in the documentation.
Modify the Doxygen comments guidelines to ensure references to functions are properly processed by Breathe: use ` (backticks) instead of @ref or @c and end functions with parentheses.
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.
Few changes to the documentation generation:
Doxyfile.in.@ref function. Update the documentation to reflect this change.