openstack/openstacksdk
Code Issues Proposed changes

Reorganize database docs

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

Change-Id: I79e9ab9abb33fde72f48c10227a6b6140b2133ba
This commit is contained in:
Brian Curtin 2017-02-15 15:21:21 -05:00
parent 8be6aed0ca
commit ce2627d327
1 changed files with 41 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
doc/source/users/proxies/database.rst
View File

@ -12,5 +12,45 @@ The database high-level interface is available through the ``database``
member of a :class:`~openstack.connection.Connection` object. The
``database`` member will only be added if the service is detected.
Database Operations
^^^^^^^^^^^^^^^^^^^
.. autoclass:: openstack.database.v1._proxy.Proxy
:members:
.. automethod:: openstack.database.v1._proxy.Proxy.create_database
.. automethod:: openstack.database.v1._proxy.Proxy.delete_database
.. automethod:: openstack.database.v1._proxy.Proxy.get_database
.. automethod:: openstack.database.v1._proxy.Proxy.find_database
.. automethod:: openstack.database.v1._proxy.Proxy.databases
Flavor Operations
^^^^^^^^^^^^^^^^^
.. autoclass:: openstack.database.v1._proxy.Proxy
.. automethod:: openstack.database.v1._proxy.Proxy.get_flavor
.. automethod:: openstack.database.v1._proxy.Proxy.find_flavor
.. automethod:: openstack.database.v1._proxy.Proxy.flavors
Instance Operations
^^^^^^^^^^^^^^^^^^^
.. autoclass:: openstack.database.v1._proxy.Proxy
.. automethod:: openstack.database.v1._proxy.Proxy.create_instance
.. automethod:: openstack.database.v1._proxy.Proxy.update_instance
.. automethod:: openstack.database.v1._proxy.Proxy.delete_instance
.. automethod:: openstack.database.v1._proxy.Proxy.get_instance
.. automethod:: openstack.database.v1._proxy.Proxy.find_instance
.. automethod:: openstack.database.v1._proxy.Proxy.instances
User Operations
^^^^^^^^^^^^^^^
.. autoclass:: openstack.database.v1._proxy.Proxy
.. automethod:: openstack.database.v1._proxy.Proxy.create_user
.. automethod:: openstack.database.v1._proxy.Proxy.delete_user
.. automethod:: openstack.database.v1._proxy.Proxy.get_user
.. automethod:: openstack.database.v1._proxy.Proxy.find_user
.. automethod:: openstack.database.v1._proxy.Proxy.users