From 650c8a5b44b3a4f2e03563256d359ff4b229dbe9 Mon Sep 17 00:00:00 2001 From: Brian Curtin Date: Tue, 28 Feb 2017 13:29:47 -0500 Subject: [PATCH] Reorganize object_store docs This change organizes the object_store docs by topic rather than letting autodoc organize methods by the order they appear in the _proxy.py file. Change-Id: I495770aaaa1bf97dd728339b3dde42ad1770e384 --- doc/source/users/proxies/object_store.rst | 37 ++++++++++++++++++++++- 1 file changed, 36 insertions(+), 1 deletion(-) diff --git a/doc/source/users/proxies/object_store.rst b/doc/source/users/proxies/object_store.rst index 3294d8b6..db685e4b 100644 --- a/doc/source/users/proxies/object_store.rst +++ b/doc/source/users/proxies/object_store.rst @@ -11,5 +11,40 @@ The Object Store Class The Object Store high-level interface is exposed as the ``object_store`` object on :class:`~openstack.connection.Connection` objects. +Account Operations +^^^^^^^^^^^^^^^^^^ + .. autoclass:: openstack.object_store.v1._proxy.Proxy - :members: + + .. automethod:: openstack.object_store.v1._proxy.Proxy.get_account_metadata + .. automethod:: openstack.object_store.v1._proxy.Proxy.set_account_metadata + .. automethod:: openstack.object_store.v1._proxy.Proxy.delete_account_metadata + +Container Operations +^^^^^^^^^^^^^^^^^^^^ + +.. autoclass:: openstack.object_store.v1._proxy.Proxy + + .. automethod:: openstack.object_store.v1._proxy.Proxy.create_container + .. automethod:: openstack.object_store.v1._proxy.Proxy.delete_container + .. automethod:: openstack.object_store.v1._proxy.Proxy.containers + + .. automethod:: openstack.object_store.v1._proxy.Proxy.get_container_metadata + .. automethod:: openstack.object_store.v1._proxy.Proxy.set_container_metadata + .. automethod:: openstack.object_store.v1._proxy.Proxy.delete_container_metadata + +Object Operations +^^^^^^^^^^^^^^^^^ + +.. autoclass:: openstack.object_store.v1._proxy.Proxy + + .. automethod:: openstack.object_store.v1._proxy.Proxy.upload_object + .. automethod:: openstack.object_store.v1._proxy.Proxy.download_object + .. automethod:: openstack.object_store.v1._proxy.Proxy.copy_object + .. automethod:: openstack.object_store.v1._proxy.Proxy.delete_object + .. automethod:: openstack.object_store.v1._proxy.Proxy.get_object + .. automethod:: openstack.object_store.v1._proxy.Proxy.objects + + .. automethod:: openstack.object_store.v1._proxy.Proxy.get_object_metadata + .. automethod:: openstack.object_store.v1._proxy.Proxy.set_object_metadata + .. automethod:: openstack.object_store.v1._proxy.Proxy.delete_object_metadata