Add user api to pylibjuju documentation #1049
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
cderici
added
kind/doc
Contributor
Author
|
@jack-w-shaw @Aflynn50 pinging for review pls, thanks! |
jack-w-shaw
approved these changes
May 29, 2024
Contributor
Author
|
/merge |
jujubot
added a commit
that referenced
this pull request
May 31, 2024
#1056 ## What's Changed * Make consume respect the controller name in the url by @Aflynn50 in #1038 * Fix multiline description in textarea in bug template GH workflow by @cderici in #1041 * Fix issue with microk8s proxy by @Aflynn50 in #1044 * add missing "revision" parameter to addModel step. by @Thanhphan1147 in #1043 * Add user api to pylibjuju documentation by @cderici in #1049 ## New Contributors * @Thanhphan1147 made their first contribution in #1043 **Full Changelog**: 3.4.0.0...3.5.0.0
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 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
Apparently we don't have the user api in pylibjuju documentation. This adds
juju.usermodule to the Sphinx build for the User api to be auto generated among all the other modules.QA Steps
No functionality changes. Watch the doc build and make sure the
juju.userpage is within the Public API section, containing docstrings for all the functions injuju.usermodule.You can also locally test this, get the changes, and run
make docs, and check thedocs/_build/apiand make sure you have thejuju.user.htmlgenerated.