doc: remove breathe from all docsets #17251
Merged
Conversation
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
github-actions
bot
added
doc-required
Contributor
|
The following west manifest projects have been modified in this Pull Request:
Note: This message is automatically posted and updated by the Manifest GitHub Action. |
Contributor
CI InformationTo view the history of this post, clich the 'edited' button above Inputs:Sources:more detailsGithub labels
List of changed files detected by CI (0)Outputs:ToolchainVersion: Test Spec & Results: ✅ Success; ❌ Failure; 🟠 Queued; 🟡 Progress; ◻️ Skipped;
|
gmarull
force-pushed
the
drop-all-breathe
branch
from
3c6425b to
5d95612
Compare
Contributor
|
You can find the documentation preview for this PR at this link. It will be updated about 10 minutes after the documentation build succeeds. Note: This comment is automatically posted by the Documentation Publishing GitHub Action. |
gmarull
force-pushed
the
drop-all-breathe
branch
5 times, most recently
from
098430f to
9f8898f
Compare
gmarull
requested review from
a team,
MarekPieta,
anangl,
b-gent,
carlescufi,
coderbyheart,
grochu,
jhirsi,
lemrey,
pdunaj,
rlubos,
tokangas,
trantanen and
umapraseeda
as code owners
bjarki-andreasen
pushed a commit
to bjarki-andreasen/sdk-nrf
that referenced
this pull request
Sep 25, 2024
until post-Breathe era becomes a reality. Ref: nrfconnect#17251 Signed-off-by: Gerard Marull-Paretas <[email protected]>
gmarull
force-pushed
the
drop-all-breathe
branch
from
f19d450 to
c5f1b99
Compare
umapraseeda
approved these changes
Sep 25, 2024
bjarki-andreasen
pushed a commit
to bjarki-andreasen/sdk-nrf
that referenced
this pull request
Sep 25, 2024
until post-Breathe era becomes a reality. Ref: nrfconnect#17251 Signed-off-by: Gerard Marull-Paretas <[email protected]>
`void` functions do not return anything, so they can't have Doxygen documentation. Signed-off-by: Gerard Marull-Paretas <[email protected]>
This is required to render Doxygen content in the same Sphinx output folder, as Doxygen is run first. Signed-off-by: Gerard Marull-Paretas <[email protected]>
So that further Sphinx+Doxygen docsets are easy to add. Signed-off-by: Gerard Marull-Paretas <[email protected]>
Native Doxygen content will be served, and Sphinx will link to it. Signed-off-by: Gerard Marull-Paretas <[email protected]>
It's no longer required as we're not using breathe anymore. Signed-off-by: Gerard Marull-Paretas <[email protected]>
Breathe will no longer be used. Signed-off-by: Gerard Marull-Paretas <[email protected]>
It is no longer needed after breathe removal. Signed-off-by: Gerard Marull-Paretas <[email protected]>
We are now serving Doxygen content, so let's drop the redundant Sphinx "shim". Signed-off-by: Gerard Marull-Paretas <[email protected]>
So we can finally _breathe_. Signed-off-by: Gerard Marull-Paretas <[email protected]>
gmarull
force-pushed
the
drop-all-breathe
branch
from
c5f1b99 to
52300d3
Compare
bjarki-andreasen
pushed a commit
to bjarki-andreasen/sdk-nrf
that referenced
this pull request
Sep 26, 2024
until post-Breathe era becomes a reality. Ref: nrfconnect#17251 Signed-off-by: Gerard Marull-Paretas <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.