[Doc] Not all relevant methods shown by autoclass
Bug #1745650 reported by
Jeremy Freudberg
This bug affects 1 person
Affects | Status | Importance | Assigned to | Milestone | |
---|---|---|---|---|---|
Python client library for Sahara |
Fix Released
|
Undecided
|
Unassigned |
Bug Description
Supporting APIv2 in saharaclient meant that there is now some fancier inheritance going on, so Sphinx :members: now misses a bunch of user-facing methods.
:inherited-members: could do the trick, but it might end up showing too much stuff. so probably we have to use the :members method1, method2: type of syntax to say exactly what we want.
To post a comment you must log in.
Reviewed: https:/ /review. openstack. org/538317 /git.openstack. org/cgit/ openstack/ python- saharaclient/ commit/ ?id=ee5f17307a1 d7949ce2408f22c 3678966d3272c1
Committed: https:/
Submitter: Zuul
Branch: master
commit ee5f17307a1d794 9ce2408f22c3678 966d3272c1
Author: Jeremy Freudberg <email address hidden>
Date: Fri Jan 26 18:02:47 2018 +0000
Auto-document members properly
Supporting APIv2 in saharaclient meant that there is now some fancier
inheritance going on, so Sphinx :members: now misses a bunch of
user-facing methods. Now, start using :inherited-members: to get what
we want.
Additionally, put the v2 docs under the main reference section instead
of in their own section.
Change-Id: I56067fe5433249 7f8d0962986383b 74a27d84a76
Closes-Bug: #1745650