diff options
| author | Ian Wienand <iwienand@redhat.com> | 2014-10-08 10:25:33 +1100 |
|---|---|---|
| committer | Ian Wienand <iwienand@redhat.com> | 2015-02-16 11:09:00 +1100 |
| commit | f272ab3ae42fd6ca2d948bea6cb37ef7b6840e35 (patch) | |
| tree | d5b0db40f35c8142c6cda08fb48e3a5d0fb89f71 /doc/source/index.rst | |
| parent | a3eaafefbdcec0231db33c44cca718526f9c96cc (diff) | |
| download | python-glanceclient-f272ab3ae42fd6ca2d948bea6cb37ef7b6840e35.tar.gz | |
Generate API documentation
As a new user I found navigating the documentation difficult. The
flow was a bit unclear and searches bring up old versions of API
references that aren't included in the current documentation.
This
- provides an introduction to the tools similar to other projects
- generates API references for the v1 and v2 client
- fixes some minor docstring issues
- adds doc/* to pep8 tests to check the conf.py
The API generation code is cribbed from python-novaclient
Change-Id: I65772127679d7afd5e7e48ca7872366b01382f21
Diffstat (limited to 'doc/source/index.rst')
| -rw-r--r-- | doc/source/index.rst | 20 |
1 files changed, 17 insertions, 3 deletions
diff --git a/doc/source/index.rst b/doc/source/index.rst index d2a16e5..5dc2470 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -1,5 +1,10 @@ +Python Bindings for the OpenStack Images API +============================================ + +This is a client for the OpenStack Images API. There's :doc:`a Python API <ref/index>` (the :mod:`glanceclient` module) and a :doc:`command-line script<man/glance>` (installed as :program:`glance`). + Python API -========== +---------- In order to use the python api directly, you must first obtain an auth token and identify which endpoint you wish to speak to. Once you have done so, you can use the API like so:: >>> from glanceclient import Client @@ -15,10 +20,19 @@ In order to use the python api directly, you must first obtain an auth token and f.write(chunk) >>> image.delete() -For an API v2 example see also :doc:`apiv2`. +Python API Reference +~~~~~~~~~~~~~~~~~~~~ + +.. toctree:: + :maxdepth: 2 + + ref/index + ref/v1/index + ref/v2/index + Command-line Tool -================= +----------------- In order to use the CLI, you must provide your OpenStack username, password, tenant, and auth endpoint. Use the corresponding configuration options (``--os-username``, ``--os-password``, ``--os-tenant-id``, and ``--os-auth-url``) or set them in environment variables:: export OS_USERNAME=user |