Document the entire API by namespace/module #2076
Merged
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
This should include the entire API. It is much more mantainable because namespaces are added far less often than classes and there is less of them.
This should include the entire Python API currently exposed.
jan-kolarik
approved these changes
Feb 19, 2025
Merged
via the queue into
rpm-software-management:main
with commit Feb 19, 2025
eb8d853
5 of 21 checks passed
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.
I made my own build of the docs so the result can be previewed: https://amatej-dnf5.readthedocs.io/en/latest/api/index.html
It would be ideal if the entire documentation was generated automatically but then the cpp and Python docs would look very different. Doing it by namespace/module still gives us enough control while there is not that many of them.
This could be revisited later.