openstack/shade
Code Issues Proposed changes
shade/doc/source/user/usage.rst
Akihiro Motoki 262061afd0 Improve doc formatting a bit 
After migrating to openstackdocstheme, some shade document became
not easy to read. This commit fixes them a bit.

- openstackdocstheme assumee only one title per page.
  Use a different level of title for the title.
  Otherwise, titles with the same level are not shown.
- Release notes page has a lot of sections. It leads to a long TOC
  in the user guide index page.
  Use maxdepth=1 explicitly for the release notes.
- Add a link to a simple example to usage.rst.
  It helps users who access the user guide directly.

Change-Id: If51afa471505296b502bed3288cc9bcf30a69ba3
2017-07-12 06:50:19 +00:00

585 B
Raw Blame History

Usage

To use shade in a project:

import shade

For a simple example, see example.

Note

API methods that return a description of an OpenStack resource (e.g., server instance, image, volume, etc.) do so using a munch.Munch object from the Munch library. Munch objects can be accessed using either dictionary or object notation (e.g., server.id, image.name and server['id'], image['name'])

shade.OpenStackCloud

shade.OperatorCloud