23 Commits

Author SHA1 Message Date
Jenkins
62aba71f8b Merge "Add the releasenote detail" 2017-01-05 07:17:04 +00:00
wanghao
d9a463233e Add doc for subscription cli
Add doc for subscription cli in python-zaqarclient.

Change-Id: I96edb8dd4a23dc01dad1f6fa641806bdc12cca22
2016-12-22 20:48:36 +08:00
wangxiyuan
794b66d0be Add the releasenote detail
This patch add the releasenote detail.

Change-Id: I6a897e204d128758067ea8e3d557700fd1f0f724
2016-12-22 20:32:04 +08:00
ZhaoBo
3bf033ad05 Add command guide for openstack ping&health CLI
Change-Id: I36fc122324a7a8b53e546e00a94ab4d22e7c7550
Co-Authored-By: wangxiyuan<wangxiyuan@huawei.com>
2016-12-22 07:47:29 +00:00
ZhaoBo
1fa91a01ad Add command guide for openstack flavor CLI
Change-Id: Iccd55c6a4aeb858f628ab68223ee0cd464a33d9f
Co-Authored-By: wangxiyuan<wangxiyuan@huawei.com>
2016-12-22 07:47:21 +00:00
ZhaoBo
41fcd3c040 Add command guide for openstack pool CLI
Change-Id: I5493e53cbc95ea17d9032c85c5bf6b16639f7a70
Co-Authored-By: wangxiyuan<wangxiyuan@huawei.com>
2016-12-22 07:47:10 +00:00
Jenkins
43a7ca8b5b Merge "Add command guide for openstack claim CLI" 2016-12-22 07:45:23 +00:00
Jenkins
cd2b2937d9 Merge "Add command guide for queue" 2016-12-22 07:45:14 +00:00
Jenkins
f07ec90a6c Merge "update doc to Api v2.0" 2016-12-22 02:13:06 +00:00
wangxiyuan
c9db6cc642 Add releasenotes for client
Change-Id: Icf5c7e7048ba9a13f88245d4eee60b8d24ecdc83
2016-12-21 14:12:00 +08:00
ZhaoBo
8eee9c3b76 Add command guide for openstack claim CLI
Change-Id: Ib7bebb90daa7c047d0d78d2856b77277552e44a7
Co-Authored-By: wangxiyuan<wangxiyuan@huawei.com>
2016-12-20 09:55:01 +00:00
wangxiyuan
83802d7c66 Add command guide for queue
Change-Id: I759fd519cb47833aab5edcc893214023a8c051b3
Co-Authored-By: ZhaoBo<zhaobo6@huawei.com>
2016-12-20 14:26:54 +08:00
wangxiyuan
002a3cf980 update doc to Api v2.0
Make the api v2.0 as the reference now.

Change-Id: I1d7dd4aa75de5d080b45c6fa7c77d56aad59bb21
2016-12-20 14:22:40 +08:00
Thomas Bechtold
bb08d6ad37 Fix doc build if git is absent
When building packages if git is absent, then we should not set
html_last_updated_fmt. It can still be set via the -D switch
when building with sphinx-build.

Change-Id: I1e1865dfcd76eb7f06dd28a5b3b401c5625fcdde
Closes-Bug: #1552251
2016-04-27 09:12:35 -05:00
Andreas Jaeger
aa372327a1 Remove unused pngmath Sphinx extension
There's no RST file that uses ".. math" and thus
the pngmath Sphinx extension is not used and can
get removed.

Change-Id: I3ea4b529025c8ac3c4092f3720124647861e6668
2016-02-29 19:58:40 +01:00
MD NADEEM
e97a78387b Fixing the deprecated library function
os.popen() is deprecated since version 2.6. Resolved with use
of subprocess module.

Change-Id: I71241cc8d47d1be4dcb20924937cb1c25afbc240
Partial-Bug: #1529836
2016-01-18 03:09:32 +00:00
Flavio Percoco
c1a0ea98b6 Release notes for 0.2.0
Change-Id: I474cd5af7f726c0af8173bfe403c13861685d0b3
2015-09-21 15:49:26 +02:00
Flavio Percoco
f0de7d6039 Relese notes for zaqarclient 0.1.1
6707d41 Drop incubating theme from docs
24aeae5 Deleted unuseful line
f81c36d Drop use of 'oslo' namespace package
0047c54 Fix handling of 1.1 API
2bd784e Gets 'flavor' data if the resource exists
f5f35d4 Gets 'pool' data if the resource exists
ff13b7a Handling exception on 504 Error
e4af424 Updated from global requirements
99f0b35 Added i18n support
2cb7e90 Makes health return True or False
19ec61d Remove unused openstack/common modules
369ac1e Adds encapsulation control to the client
f96c739 Updated from global requirements
4d957e6 Extend some docstrings with useful information
632c893 Add reference docs for latest recommended client
be666ff Add docs for `Client` instances
d8a5061 Setup developer docs for zaqarclient
a411bf0 Fix the client name typo
4e60be5 Updated from global requirements
ad673c5 fix KeystoneAuth doc string
0c6c0d7 Updated from global requirements
d721b75 Updates API name
ebb8d56 Add a read-only property for Queues

Change-Id: I38d88788a3753da888211055de91e3aa1a9d7bbb
2015-05-28 09:46:04 +02:00
Joe Gordon
6707d41116 Drop incubating theme from docs
OpenStack has dropped the incubation notion, so labeling this as an
incubated project in the docs is confusing.

Change-Id: I1893fa76affb5e712abef6765e373077b2fc6832
2015-05-27 12:21:55 -07:00
Flavio Percoco
4d957e6ed6 Extend some docstrings with useful information
This patch extends some of the docstrings in the `Client` class with
more useful information. The patch also adds `intersphinx` to allow for
linking to other docs within zaqarclient. For example:

    :rtype: :class:`zaqarclient.transport.base.Transport`

will link to the documentation for Transport if it has been generated.

Change-Id: I928d63d74739e9e18709979e79c95b5606d97032
2014-10-23 22:27:19 +02:00
Flavio Percoco
632c89336e Add reference docs for latest recommended client
Add the reference documentation for the latest supported client version.
Older versions will also be linked there as they come.

Change-Id: I4d9da31ed0aa39ba6cdafb7ad61af1197d4610e4
2014-10-23 22:27:19 +02:00
Flavio Percoco
be666ff985 Add docs for Client instances
This patch documents the basic usage of `Client` instances. It does not
provide a detailed documentation about the methods exposed but a high
level documentation of what the recommended way to access these
resources is.

The current version refers to sections like 'core API', 'config' and
others that haven't been documented yet. Once they will be, proper links
to those sections will be added here.

Change-Id: I705498b8e4c19c75c9697419d1fd90c9a9ae40b9
2014-10-23 22:27:19 +02:00
Flavio Percoco
d8a50610ed Setup developer docs for zaqarclient
Zaqar's client library is lacking of any kind of documentation. This
needs to be fixed, hence this patch. The patch adds the docs'
infrastructure to start writing the required documentation for the
library.

Change-Id: Ife171e352da4ec977202efcb3f1dcf573edcdc27
2014-10-23 22:27:12 +02:00