Files
python-novaclient/doc/source/index.rst
Stephen Finucane e11efd8d76 doc: Create directory structure for docs migration
The spec [1] recommends the following sections:

- install
- contributor
- configuration
- cli
- admin
- user
- reference

Only a few of these are useful here:

- contributor
- cli
- user
- reference

Add these and populate them.

[1] specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration

Change-Id: I8a9ddcc915f25ebfaa1e994dba6c15883bd2715d
2017-07-12 15:07:35 +01:00

28 lines
881 B
ReStructuredText

===========================================
Python bindings to the OpenStack Nova API
===========================================
This is a client for OpenStack Nova API. There's :doc:`a Python API
<reference/api/index>` (the :mod:`novaclient` module), and a :doc:`command-line
script </user/shell>` (installed as :program:`nova`). Each implements the
entire OpenStack Nova API.
You'll need credentials for an OpenStack cloud that implements the Compute API,
such as TryStack, HP, or Rackspace, in order to use the nova client.
.. seealso::
You may want to read the `OpenStack Compute API Guide`__
to get an idea of the concepts. By understanding the concepts
this library should make more sense.
__ https://developer.openstack.org/api-guide/compute/index.html
.. toctree::
:maxdepth: 2
user/index
reference/index
cli/index
contributor/index