openstack/deb-python-openstacksdk
Code Issues Proposed changes

Reorganize bare_metal docs

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

Change-Id: I24ec3db3fc24f1417d13c91a344e3ebeb622bb40
This commit is contained in:
Brian Curtin
2017-02-15 11:03:22 -05:00
parent 8be6aed0ca
commit f211be85ea
1 changed files with 61 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

62
doc/source/users/proxies/bare_metal.rst
View File

@@ -12,5 +12,65 @@ The bare_metal high-level interface is available through the ``bare_metal``
member of a :class:`~openstack.connection.Connection` object.
The ``bare_metal`` member will only be added if the service is detected.
Node Operations
^^^^^^^^^^^^^^^
.. autoclass:: openstack.bare_metal.v1._proxy.Proxy
:members:
.. automethod:: openstack.bare_metal.v1._proxy.Proxy.create_node
.. automethod:: openstack.bare_metal.v1._proxy.Proxy.update_node
.. automethod:: openstack.bare_metal.v1._proxy.Proxy.delete_node
.. automethod:: openstack.bare_metal.v1._proxy.Proxy.get_node
.. automethod:: openstack.bare_metal.v1._proxy.Proxy.find_node
.. automethod:: openstack.bare_metal.v1._proxy.Proxy.nodes
Port Operations
^^^^^^^^^^^^^^^
.. autoclass:: openstack.bare_metal.v1._proxy.Proxy
.. automethod:: openstack.bare_metal.v1._proxy.Proxy.create_port
.. automethod:: openstack.bare_metal.v1._proxy.Proxy.update_port
.. automethod:: openstack.bare_metal.v1._proxy.Proxy.delete_port
.. automethod:: openstack.bare_metal.v1._proxy.Proxy.get_port
.. automethod:: openstack.bare_metal.v1._proxy.Proxy.find_port
.. automethod:: openstack.bare_metal.v1._proxy.Proxy.ports
Port Group Operations
^^^^^^^^^^^^^^^^^^^^^
.. autoclass:: openstack.bare_metal.v1._proxy.Proxy
.. automethod:: openstack.bare_metal.v1._proxy.Proxy.create_port_group
.. automethod:: openstack.bare_metal.v1._proxy.Proxy.update_port_group
.. automethod:: openstack.bare_metal.v1._proxy.Proxy.delete_port_group
.. automethod:: openstack.bare_metal.v1._proxy.Proxy.get_port_group
.. automethod:: openstack.bare_metal.v1._proxy.Proxy.find_port_group
.. automethod:: openstack.bare_metal.v1._proxy.Proxy.port_groups
Driver Operations
^^^^^^^^^^^^^^^^^
.. autoclass:: openstack.bare_metal.v1._proxy.Proxy
.. automethod:: openstack.bare_metal.v1._proxy.Proxy.drivers
.. automethod:: openstack.bare_metal.v1._proxy.Proxy.get_driver
Chassis Operations
^^^^^^^^^^^^^^^^^^
.. autoclass:: openstack.bare_metal.v1._proxy.Proxy
.. automethod:: openstack.bare_metal.v1._proxy.Proxy.create_chassis
.. automethod:: openstack.bare_metal.v1._proxy.Proxy.update_chassis
.. automethod:: openstack.bare_metal.v1._proxy.Proxy.delete_chassis
.. automethod:: openstack.bare_metal.v1._proxy.Proxy.get_chassis
.. automethod:: openstack.bare_metal.v1._proxy.Proxy.find_chassis
.. automethod:: openstack.bare_metal.v1._proxy.Proxy.chassis
Deprecated Methods
^^^^^^^^^^^^^^^^^^
.. autoclass:: openstack.bare_metal.v1._proxy.Proxy
.. automethod:: openstack.bare_metal.v1._proxy.Proxy.create_portgroup
.. automethod:: openstack.bare_metal.v1._proxy.Proxy.update_portgroup
.. automethod:: openstack.bare_metal.v1._proxy.Proxy.delete_portgroup
.. automethod:: openstack.bare_metal.v1._proxy.Proxy.get_portgroup
.. automethod:: openstack.bare_metal.v1._proxy.Proxy.find_portgroup
.. automethod:: openstack.bare_metal.v1._proxy.Proxy.portgroups