Skip to content

Commit 41a242b

Browse files
authored
Merge pull request #1049 from cderici/documentation-add-user-api
#1049 #### Description Apparently we don't have the user api in [pylibjuju documentation](https://pythonlibjuju.readthedocs.io/en/latest/api/modules.html). This adds `juju.user` module 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.user` page is within the Public API section, containing docstrings for all the functions in `juju.user` module. You can also locally test this, get the changes, and run `make docs`, and check the `docs/_build/api` and make sure you have the `juju.user.html` generated.
2 parents d4f6677 + e0d8d16 commit 41a242b

2 files changed

Lines changed: 14 additions & 0 deletions

File tree

docs/api/juju.user.rst

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
juju.user
2+
==========
3+
4+
.. rubric:: Summary
5+
6+
.. automembersummary:: juju.user
7+
8+
.. rubric:: Reference
9+
10+
.. automodule:: juju.user
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:

docs/api/modules.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ If you need helpers to manage the asyncio loop, try :doc:`juju.loop`.
2323
juju.relation
2424
juju.tag
2525
juju.unit
26+
juju.user
2627
juju.utils
2728

2829
.. automodule:: juju

0 commit comments

Comments
 (0)