doc: extensions: doxygen: add support for multiple projects #82432
+225
−206
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
gmarull
force-pushed
the
doxygen-multiproject
branch
2 times, most recently
from
ff07ca3
to
4bd6c52
Compare
The extension had a some major design flaws, mainly: - Ignored the `api_overview_doxygen_xml_dir` setting, instead it "sniffed" doxyrunner properties, so violating environment boundaries - Computation of Doxygen HTML path worked because of the hardcoded URL in relative form found in doc/conf.py This patch moves most code to the actual directive, so that context can be obtained from the document being parsed. Also, the only config required now is the Doxygen output dir, obtained from doxyrunner at conf.py level. Signed-off-by: Gerard Marull-Paretas <[email protected]>
Modify the extension so that multiple Doxygen projects can be added. While not required in upstream Zephyr, other users downstream may require support for this feature. Signed-off-by: Gerard Marull-Paretas <[email protected]>
Modify the extension so that multiple Doxygen projects can be referenced. While not required in upstream Zephyr, other users downstream may require support for this feature. Signed-off-by: Gerard Marull-Paretas <[email protected]>
gmarull
force-pushed
the
doxygen-multiproject
branch
from
4bd6c52
to
779b0c7
Compare
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.
Add support for multiple Doxygen projects to doxyrunner/doxybridge extensions. While not needed upstream, some other projects may benefit from this option when re-using the extension.
Also refactored the api_overview extension as it had some major flaws (see commit for details)
TODO:
:external+xyz:fordoxybridgehttps://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html#role-external, like:project+zephyr:so that we can create explicit references or be able to resolve any potential collision.