diff options
author | ZhiQiang Fan <aji.zqfan@gmail.com> | 2015-04-06 10:04:23 +0800 |
---|---|---|
committer | Pradeep Kilambi <pkilambi@redhat.com> | 2015-04-16 11:06:54 -0400 |
commit | 5a3697d0b95b3d9919d702a9017c378ace98e429 (patch) | |
tree | bf10b06e4bcdb44872081f14882022ec00bf388f | |
parent | 1b346fb64796cd9aba39ee1e9453223738bd1b30 (diff) | |
download | python-ceilometerclient-5a3697d0b95b3d9919d702a9017c378ace98e429.tar.gz |
fix client docstring
* fix broken docstring in ceilometerclient.client
* remove non-existent `release` index
* remove duplicated reference generation in ext/gen_ref.py
Change-Id: Iad8c527e61628a406d5dd84adac875190b994fac
Closes-Bug: #1440629
(cherry picked from commit 2ea94891ea964710ea76e774a805bdff589a0b80)
-rw-r--r-- | ceilometerclient/client.py | 2 | ||||
-rw-r--r-- | doc/ext/gen_ref.py | 5 | ||||
-rw-r--r-- | doc/source/index.rst | 1 |
3 files changed, 2 insertions, 6 deletions
diff --git a/ceilometerclient/client.py b/ceilometerclient/client.py index c0a8be5..46cd66f 100644 --- a/ceilometerclient/client.py +++ b/ceilometerclient/client.py @@ -256,7 +256,9 @@ def get_client(version, **kwargs): * ceilometer_url: (DEPRECATED) Ceilometer API endpoint, use os_endpoint instead * os_endpoint: Ceilometer API endpoint + or: + * os_username: name of user * os_password: user's password * os_user_id: user's id diff --git a/doc/ext/gen_ref.py b/doc/ext/gen_ref.py index f3ea677..f8560b3 100644 --- a/doc/ext/gen_ref.py +++ b/doc/ext/gen_ref.py @@ -52,8 +52,3 @@ def gen_ref(ver, title, names): % {"title": name.capitalize(), "signs": "=" * len(name), "pkg": pkg, "name": name}) - -gen_ref("", "Client Reference", ["client", "exc"]) -gen_ref("v1", "Version 1 API Reference", - ["stacks", "resources", "events", "actions", - "software_configs", "software_deployments"]) diff --git a/doc/source/index.rst b/doc/source/index.rst index 56f671a..cec3b5c 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -24,7 +24,6 @@ Contents: ref/index ref/v1/index ref/v2/index - releases Contributing ============ |