openstack/deb-python-openstacksdk
Code Issues Proposed changes

Reorganize image docs

Browse Source 
This change organizes the image docs by topic rather than letting
autodoc organize methods by the order they appear in the _proxy.py file.

Change-Id: I798931fd3fecf51b922526fadb2ae243c4fc8c52
This commit is contained in:
Brian Curtin
2017-02-15 17:15:55 -05:00
parent 8858995c97
commit 059d89c4a1
4 changed files with 66 additions and 34 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
doc/source/users/index.rst
View File

@@ -76,7 +76,8 @@ but listed below are the ones provided by this SDK by default.
Compute <proxies/compute> Compute <proxies/compute>
Database <proxies/database> Database <proxies/database>
Identity <proxies/identity> Identity <proxies/identity>
Image <proxies/image> Image v1 <proxies/image_v1>
Image v2 <proxies/image_v2>
Key Manager <proxies/key_manager> Key Manager <proxies/key_manager>
Network <proxies/network> Network <proxies/network>
Object Store <proxies/object_store> Object Store <proxies/object_store>

33
doc/source/users/proxies/image.rst
View File

@@ -1,33 +0,0 @@
Image API v1
============
For details on how to use image, see :doc:`/users/guides/image`
.. automodule:: openstack.image.v1._proxy
The Image v1 Class
------------------
The image high-level interface is available through the ``image`` member of a
:class:`~openstack.connection.Connection` object. The ``image`` member will
only be added if the service is detected.
.. autoclass:: openstack.image.v1._proxy.Proxy
:members:
Image API v2
============
For details on how to use image, see :doc:`/users/guides/image`
.. automodule:: openstack.image.v2._proxy
The Image v2 Class
------------------
The image high-level interface is available through the ``image`` member of a
:class:`~openstack.connection.Connection` object. The ``image`` member will
only be added if the service is detected.
.. autoclass:: openstack.image.v2._proxy.Proxy
:members:

22
doc/source/users/proxies/image_v1.rst Normal file
View File

@@ -0,0 +1,22 @@
Image API v1
============
For details on how to use image, see :doc:`/users/guides/image`
.. automodule:: openstack.image.v1._proxy
The Image v1 Class
------------------
The image high-level interface is available through the ``image`` member of a
:class:`~openstack.connection.Connection` object. The ``image`` member will
only be added if the service is detected.
.. autoclass:: openstack.image.v1._proxy.Proxy
.. automethod:: openstack.image.v1._proxy.Proxy.upload_image
.. automethod:: openstack.image.v1._proxy.Proxy.update_image
.. automethod:: openstack.image.v1._proxy.Proxy.delete_image
.. automethod:: openstack.image.v1._proxy.Proxy.get_image
.. automethod:: openstack.image.v1._proxy.Proxy.find_image
.. automethod:: openstack.image.v1._proxy.Proxy.images

42
doc/source/users/proxies/image_v2.rst Normal file
View File

@@ -0,0 +1,42 @@
Image API v2
============
For details on how to use image, see :doc:`/users/guides/image`
.. automodule:: openstack.image.v2._proxy
The Image v2 Class
------------------
The image high-level interface is available through the ``image`` member of a
:class:`~openstack.connection.Connection` object. The ``image`` member will
only be added if the service is detected.
Image Operations
^^^^^^^^^^^^^^^^
.. autoclass:: openstack.image.v2._proxy.Proxy
.. automethod:: openstack.image.v2._proxy.Proxy.upload_image
.. automethod:: openstack.image.v2._proxy.Proxy.download_image
.. automethod:: openstack.image.v2._proxy.Proxy.update_image
.. automethod:: openstack.image.v2._proxy.Proxy.delete_image
.. automethod:: openstack.image.v2._proxy.Proxy.get_image
.. automethod:: openstack.image.v2._proxy.Proxy.find_image
.. automethod:: openstack.image.v2._proxy.Proxy.images
.. automethod:: openstack.image.v2._proxy.Proxy.deactivate_image
.. automethod:: openstack.image.v2._proxy.Proxy.reactivate_image
.. automethod:: openstack.image.v2._proxy.Proxy.add_tag
.. automethod:: openstack.image.v2._proxy.Proxy.remove_tag
Member Operations
^^^^^^^^^^^^^^^^^
.. autoclass:: openstack.image.v2._proxy.Proxy
.. automethod:: openstack.image.v2._proxy.Proxy.add_member
.. automethod:: openstack.image.v2._proxy.Proxy.remove_member
.. automethod:: openstack.image.v2._proxy.Proxy.update_member
.. automethod:: openstack.image.v2._proxy.Proxy.get_member
.. automethod:: openstack.image.v2._proxy.Proxy.find_member
.. automethod:: openstack.image.v2._proxy.Proxy.members