doc: libnetplan API reference, using Doxygen and Sphinx.breathe#423
Merged
slyon merged 4 commits intocanonical:mainfrom Nov 28, 2023
Merged
doc: libnetplan API reference, using Doxygen and Sphinx.breathe#423slyon merged 4 commits intocanonical:mainfrom
slyon merged 4 commits intocanonical:mainfrom
Conversation
slyon
force-pushed
the
apidoc-doxygen
branch
from
3152319 to
3732272
Compare
Contributor
Author
|
We might even consider dropping the top-level |
slyon
force-pushed
the
apidoc-doxygen
branch
from
3732272 to
846ce9b
Compare
rkratky
approved these changes
Nov 27, 2023
slyon
force-pushed
the
apidoc-doxygen
branch
from
846ce9b to
c144efb
Compare
Contributor
Author
|
Thanks a lot for the prompt review! I addressed all the nitpicks. Will merge once the CI is (mostly) green. |
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
2 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.
Description
Setting up a structure to make use of Doxygen and Sphinx' Breathe the generate a API documentation reference for
libnetplandirectly from the source and header files.The documentation is generated at doc-build time (
make runinsidedoc/) and also run on readthedocs, so we show the most current documentation from the sources at all times.We make use of Breathe's
autodoxygenfeatures, so that we don't need to generate and parse Doxygen's XML output manually.FR-3781
Checklist
make checksuccessfully.make check-coverage).