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: I56067fe54332497f8d0962986383b74a27d84a76 Closes-Bug: #1745650
This commit is contained in:
parent
bcd2b25179
commit
ee5f17307a
|
@ -21,7 +21,6 @@ Contents:
|
|||
:maxdepth: 2
|
||||
|
||||
reference/index
|
||||
v2_reference/index
|
||||
cli/index
|
||||
contributor/index
|
||||
|
||||
|
|
|
@ -6,3 +6,4 @@ Reference guide
|
|||
:maxdepth: 2
|
||||
|
||||
pythonclient
|
||||
pythonclient_v2
|
||||
|
|
|
@ -105,36 +105,42 @@ Plugin ops
|
|||
|
||||
.. autoclass:: saharaclient.api.plugins.PluginManagerV1
|
||||
:members:
|
||||
:inherited-members:
|
||||
|
||||
Image Registry ops
|
||||
~~~~~~~~~~~~~~~~~~
|
||||
|
||||
.. autoclass:: saharaclient.api.images.ImageManagerV1
|
||||
:members:
|
||||
:inherited-members:
|
||||
|
||||
Node Group Template ops
|
||||
~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
.. autoclass:: saharaclient.api.node_group_templates.NodeGroupTemplateManagerV1
|
||||
:members:
|
||||
:inherited-members:
|
||||
|
||||
Cluster Template ops
|
||||
~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
.. autoclass:: saharaclient.api.cluster_templates.ClusterTemplateManagerV1
|
||||
:members:
|
||||
:inherited-members:
|
||||
|
||||
Cluster ops
|
||||
~~~~~~~~~~~
|
||||
|
||||
.. autoclass:: saharaclient.api.clusters.ClusterManagerV1
|
||||
:members:
|
||||
:inherited-members:
|
||||
|
||||
Data Source ops
|
||||
~~~~~~~~~~~~~~~
|
||||
|
||||
.. autoclass:: saharaclient.api.data_sources.DataSourceManagerV1
|
||||
:members:
|
||||
:inherited-members:
|
||||
|
||||
Job Binary Internal ops
|
||||
~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
@ -147,21 +153,25 @@ Job Binary ops
|
|||
|
||||
.. autoclass:: saharaclient.api.job_binaries.JobBinariesManagerV1
|
||||
:members:
|
||||
:inherited-members:
|
||||
|
||||
Job ops
|
||||
~~~~~~~
|
||||
|
||||
.. autoclass:: saharaclient.api.jobs.JobsManagerV1
|
||||
:members:
|
||||
:inherited-members:
|
||||
|
||||
Job Execution ops
|
||||
~~~~~~~~~~~~~~~~~
|
||||
|
||||
.. autoclass:: saharaclient.api.job_executions.JobExecutionsManager
|
||||
:members:
|
||||
:inherited-members:
|
||||
|
||||
Job Types ops
|
||||
~~~~~~~~~~~~~
|
||||
|
||||
.. autoclass:: saharaclient.api.job_types.JobTypesManager
|
||||
:members:
|
||||
:inherited-members:
|
||||
|
|
|
@ -15,58 +15,68 @@ Plugin ops
|
|||
|
||||
.. autoclass:: saharaclient.api.plugins.PluginManagerV2
|
||||
:members:
|
||||
:inherited-members:
|
||||
|
||||
Image Registry ops
|
||||
~~~~~~~~~~~~~~~~~~
|
||||
|
||||
.. autoclass:: saharaclient.api.images.ImageManagerV2
|
||||
:members:
|
||||
:inherited-members:
|
||||
|
||||
Node Group Template ops
|
||||
~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
.. autoclass:: saharaclient.api.node_group_templates.NodeGroupTemplateManagerV2
|
||||
:members:
|
||||
:inherited-members:
|
||||
|
||||
Cluster Template ops
|
||||
~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
.. autoclass:: saharaclient.api.cluster_templates.ClusterTemplateManagerV2
|
||||
:members:
|
||||
:inherited-members:
|
||||
|
||||
Cluster ops
|
||||
~~~~~~~~~~~
|
||||
|
||||
.. autoclass:: saharaclient.api.clusters.ClusterManagerV2
|
||||
:members:
|
||||
:inherited-members:
|
||||
|
||||
Data Source ops
|
||||
~~~~~~~~~~~~~~~
|
||||
|
||||
.. autoclass:: saharaclient.api.data_sources.DataSourceManagerV2
|
||||
:members:
|
||||
:inherited-members:
|
||||
|
||||
Job Binary ops
|
||||
~~~~~~~~~~~~~~
|
||||
|
||||
.. autoclass:: saharaclient.api.job_binaries.JobBinariesManagerV2
|
||||
:members:
|
||||
:inherited-members:
|
||||
|
||||
Job Template ops
|
||||
~~~~~~~~~~~~~~~~
|
||||
|
||||
.. autoclass:: saharaclient.api.v2.job_templates.JobTemplatesManagerV2
|
||||
:members:
|
||||
:inherited-members:
|
||||
|
||||
Job ops
|
||||
~~~~~~~
|
||||
|
||||
.. autoclass:: saharaclient.api.v2.jobs.JobsManagerV2
|
||||
:members:
|
||||
:inherited-members:
|
||||
|
||||
Job Types ops
|
||||
~~~~~~~~~~~~~
|
||||
|
||||
.. autoclass:: saharaclient.api.job_types.JobTypesManager
|
||||
:members:
|
||||
:inherited-members:
|
||||
:noindex:
|
|
@ -1,8 +0,0 @@
|
|||
===============
|
||||
Reference guide
|
||||
===============
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
pythonclient_v2
|
Loading…
Reference in New Issue