diff options
| author | Jeremy Freudberg <jeremyfreudberg@gmail.com> | 2018-01-26 18:02:47 +0000 |
|---|---|---|
| committer | Jeremy Freudberg <jeremyfreudberg@gmail.com> | 2018-01-26 18:02:47 +0000 |
| commit | ee5f17307a1d7949ce2408f22c3678966d3272c1 (patch) | |
| tree | 55bdeef7ee9be3bfdc352e7272772f3c1656124a | |
| parent | bcd2b2517969ab59a6e9a9d40dcb19711daf452f (diff) | |
| download | python-saharaclient-ee5f17307a1d7949ce2408f22c3678966d3272c1.tar.gz | |
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
| -rw-r--r-- | doc/source/index.rst | 1 | ||||
| -rw-r--r-- | doc/source/reference/index.rst | 1 | ||||
| -rw-r--r-- | doc/source/reference/pythonclient.rst | 10 | ||||
| -rw-r--r-- | doc/source/reference/pythonclient_v2.rst (renamed from doc/source/v2_reference/pythonclient_v2.rst) | 10 | ||||
| -rw-r--r-- | doc/source/v2_reference/index.rst | 8 |
5 files changed, 21 insertions, 9 deletions
diff --git a/doc/source/index.rst b/doc/source/index.rst index 2d25c41..68c0f56 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -21,7 +21,6 @@ Contents: :maxdepth: 2 reference/index - v2_reference/index cli/index contributor/index diff --git a/doc/source/reference/index.rst b/doc/source/reference/index.rst index be67a9e..39461f2 100644 --- a/doc/source/reference/index.rst +++ b/doc/source/reference/index.rst @@ -6,3 +6,4 @@ Reference guide :maxdepth: 2 pythonclient + pythonclient_v2 diff --git a/doc/source/reference/pythonclient.rst b/doc/source/reference/pythonclient.rst index 7ba2e45..30a36fe 100644 --- a/doc/source/reference/pythonclient.rst +++ b/doc/source/reference/pythonclient.rst @@ -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: diff --git a/doc/source/v2_reference/pythonclient_v2.rst b/doc/source/reference/pythonclient_v2.rst index ab2d833..f301e42 100644 --- a/doc/source/v2_reference/pythonclient_v2.rst +++ b/doc/source/reference/pythonclient_v2.rst @@ -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: diff --git a/doc/source/v2_reference/index.rst b/doc/source/v2_reference/index.rst deleted file mode 100644 index d4d8001..0000000 --- a/doc/source/v2_reference/index.rst +++ /dev/null @@ -1,8 +0,0 @@ -=============== -Reference guide -=============== - -.. toctree:: - :maxdepth: 2 - - pythonclient_v2 |