Repository navigation
docs: Doxygen XML only for the Sphinx API reference - #335
Merged
Merged
Conversation
Doxyfile_API is only used by docs/conf.py (breathe reads its XML); the
standalone HTML/Qt help uses docs/Doxyfile. It also generated HTML,
Qt help and include graphs: the graphs failed on Read the Docs ('dot' is
not installed), and three options are obsolete in current Doxygen. The
API reference pages are unchanged (same documented members).
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
1 participant
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.
The first Read the Docs build since 2023 succeeded (latest =
dev), but its log had Doxygen errors:Doxyfile_APIalso generated HTML, Qt help and include graphs, and the graphs fail there because Graphviz (dot) isn't installed. It also used three options current Doxygen reports as obsolete.Doxyfile_APIis only used bydocs/conf.py(breathe reads the XML), so it now generates XML only.docs/Doxyfile(HTML/Qt help) is untouched. Checked locally: no Doxygen config warnings, no Sphinx warnings, and the five API reference pages have exactly the same members as the live site.