Remove Breathe #1986
Merged
Remove Breathe #1986
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
breathe-remove
branch
2 times, most recently
from
8286185 to
a3c8ba5
Compare
NordicBuilder
requested review from
57300,
asbjornsabo,
hermabe,
tejlmand and
Thalley
nordicjm
approved these changes
Sep 2, 2024
thst-nordic
reviewed
Sep 3, 2024
| @@ -73,7 +73,6 @@ | |||
| # -- General configuration ------------------------------------------------ | |||
|
|
|||
| extensions = [ | |||
| "breathe", | |||
There was a problem hiding this comment.
why was breathe removed?
Will it affect nordic's documentation team?
There was a problem hiding this comment.
Breathe was a resource hog for the project, so an alternative has been introduced. We are all aware and already have a working solution that is to serve Doxygen content as upstream does. Btw, documentation CI will be much faster, so no workarounds to make it fast will be needed.
Some extensions may be able to run faster if they can check if Doxygen contents has changed from one build to the other Signed-off-by: Benjamin Cabé <[email protected]> (cherry picked from commit 02ad7ef)
…:c:enumerator: While Breathe seems to not care and creates hyperlinks either way, the proper role to mention a C enumerator is :c:enumerator:. :c:enum: is to be used to refer to the enum itself. Signed-off-by: Benjamin Cabé <[email protected]> (cherry picked from commit 5a5fd7c)
… c domain roles Simplify how the code sample refers to C objects to be less dependant on Breathe. Signed-off-by: Benjamin Cabé <[email protected]> (cherry picked from commit f2227bb)
Do not pass options to doxygengroup to rationalize usage and be less dependent on Breathe. Signed-off-by: Benjamin Cabé <[email protected]> (cherry picked from commit 385f8e1)
Deactivate breathe extension from docs. Signed-off-by: Gerard Marull-Paretas <[email protected]> (cherry picked from commit 259db8c)
Add an initial version of doxybridge, an extension that allows to use Sphinx C domain to automatically reference Doxygen pages. It also introduces minimal support for `.. doxygengroup` directive, which effectively links to the group's Doxygen page. Co-authored-by: Benjamin Cabé <[email protected]> Signed-off-by: Gerard Marull-Paretas <[email protected]> Signed-off-by: Benjamin Cabé <[email protected]> (cherry picked from commit c8c3a3b)
Enable the doxybridge extension. Signed-off-by: Gerard Marull-Paretas <[email protected]> (cherry picked from commit ea14a07)
Minor cosmetic update post Breathe removal Signed-off-by: Benjamin Cabé <[email protected]> (cherry picked from commit 162fa76)
The newly insterted directive is patching the new Zephyr bridge extension instead of breathe's one. Doxybridge does not support the same arguments as breathe, so, Zephyr domain can't be used on projects that still use breathe. Disable until all NCS projects are ported. Signed-off-by: Gerard Marull-Paretas <[email protected]>
gmarull
force-pushed
the
breathe-remove
branch
from
acba4a5 to
ce86ca2
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.
No description provided.