Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: libnetplan API reference, using Doxygen and Sphinx.breathe #423

Merged
merged 4 commits into from Nov 28, 2023

Conversation

slyon
Copy link
Collaborator

@slyon slyon commented Nov 27, 2023

Description

Setting up a structure to make use of Doxygen and Sphinx' Breathe the generate a API documentation reference for libnetplan directly from the source and header files.

The documentation is generated at doc-build time (make run inside doc/) and also run on readthedocs, so we show the most current documentation from the sources at all times.

We make use of Breathe's autodoxygen features, so that we don't need to generate and parse Doxygen's XML output manually.

FR-3781

Checklist

  • Runs make check successfully.
  • Retains 100% code coverage (make check-coverage).
  • New/changed keys in YAML format are documented.
  • (Optional) Adds example YAML for new feature.
  • (Optional) Closes an open bug in Launchpad.

@slyon slyon requested a review from rkratky November 27, 2023 14:13
@slyon slyon marked this pull request as ready for review November 27, 2023 14:13
@slyon
Copy link
Collaborator Author

slyon commented Nov 27, 2023

We might even consider dropping the top-level Doxyfile configuration, I think it's not necessarily needed.

Copy link
Contributor

@rkratky rkratky left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@slyon A few nitpicks.

include/util.h Outdated Show resolved Hide resolved
include/util.h Outdated Show resolved Hide resolved
include/util.h Outdated Show resolved Hide resolved
include/util.h Outdated Show resolved Hide resolved
include/util.h Outdated Show resolved Hide resolved
@slyon
Copy link
Collaborator Author

slyon commented Nov 27, 2023

Thanks a lot for the prompt review! I addressed all the nitpicks. Will merge once the CI is (mostly) green.

@slyon slyon merged commit 62b693e into canonical:main Nov 28, 2023
14 of 15 checks passed
@slyon slyon added the documentation Documentation improvements. label Jan 31, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Documentation improvements.
Projects
None yet
2 participants