ee5f17307a
Supporting APIv2 in saharaclient meant that there is now some fancier inheritance going on, so Sphinx :members: now misses a bunch of user-facing methods. Now, start using :inherited-members: to get what we want. Additionally, put the v2 docs under the main reference section instead of in their own section. Change-Id: I56067fe54332497f8d0962986383b74a27d84a76 Closes-Bug: #1745650
27 lines
804 B
ReStructuredText
27 lines
804 B
ReStructuredText
Python bindings to the OpenStack Sahara API
|
|
===========================================
|
|
|
|
This is a client for OpenStack Sahara API. There's :doc:`a Python API client
|
|
<reference/index>` (the :mod:`saharaclient` module), and a :doc:`command-line utility
|
|
<cli/index>` (installed as an OpenStackClient plugin). Each implements the entire
|
|
OpenStack Sahara API.
|
|
|
|
You'll need credentials for an OpenStack cloud that implements the
|
|
Data Processing API, in order to use the sahara client.
|
|
|
|
You may want to read the `OpenStack Sahara Docs`__ -- the overview, at
|
|
least -- to get an idea of the concepts. By understanding the concepts
|
|
this library should make more sense.
|
|
|
|
__ https://docs.openstack.org/sahara/latest/
|
|
|
|
Contents:
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
reference/index
|
|
cli/index
|
|
contributor/index
|
|
|