The doc of message is missing in zaqarclient.
So this patch will add it and also remove the unused docs for
other resources.
Change-Id: I55c745a81226487292220edfb629ca4f7dfd95d7
Closes-Bug: #1893145
Signed-off-by: wanghao <sxmatch1986@gmail.com>
Switch to openstackdocstheme 2.2.1 and reno 3.1.0 versions. Using
these versions will allow especially:
* Linking from HTML to PDF document
* Allow parallel building of documents
* Fix some rendering problems
Update Sphinx version as well.
Remove docs requirements from lower-constraints, they are not needed
during install or test but only for docs building.
openstackdocstheme renames some variables, so follow the renames
before the next release removes them. A couple of variables are also
not needed anymore, remove them.
Change pygments_style to 'native' since old theme version always used
'native' and the theme now respects the setting and using 'sphinx' can
lead to some strange rendering.
See also
http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html
Change-Id: Iafd5fb0f99a2b68c6f4a3118bf7d7c3a8881465f
This repo is now testing only with Python 3, so let's make
a few cleanups:
- Remove python 2.7 stanza from setup.py
- Add requires on python >= 3.6 to setup.cfg so that pypi and pip
know about the requirement
- Remove obsolete sections from setup.cfg
- Update classifiers
- Use newer openstackdocstheme and Sphinx versions
- Cleanup */source/conf.py to remove now obsolete content.
- Remove install_command from tox.ini, the default is fine
Change-Id: I623b1e0bfc2ec8cd9ce017556101cdeb06a1bb4c
As part of the docs migration work[0] for Pike we need to switch to use
the openstackdocstheme.
[0]https://review.openstack.org/#/c/472275/
Change-Id: I8aad9f2c5f610f8f5241fdddc21ea2a0536d1fd3
All the zaqarclient command have been added according to 'openstack
messaging XXX' format,see [1] , this patch update doc accordingly.
[1] https://review.openstack.org/#/c/470201/
Change-Id: I552b0b95c960b17d25272c53863e16e191428da2
Now we only have 'pool' description in pool flavor create.
This patch adds this description to other pool flavor commands.
This will help users understanding this is a pool flover.
Change-Id: I9423e42f8b8222fa25d6a73db9e0bdafb20248f8
The line of "coding: utf-8" is added by some editors automatically.
It is useless, can be removed.
Change-Id: I50ded5ec5140cfbcfdaa1a09ac816e6c88969000
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
There's no RST file that uses ".. math" and thus
the pngmath Sphinx extension is not used and can
get removed.
Change-Id: I3ea4b529025c8ac3c4092f3720124647861e6668
os.popen() is deprecated since version 2.6. Resolved with use
of subprocess module.
Change-Id: I71241cc8d47d1be4dcb20924937cb1c25afbc240
Partial-Bug: #1529836
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
OpenStack has dropped the incubation notion, so labeling this as an
incubated project in the docs is confusing.
Change-Id: I1893fa76affb5e712abef6765e373077b2fc6832
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
Add the reference documentation for the latest supported client version.
Older versions will also be linked there as they come.
Change-Id: I4d9da31ed0aa39ba6cdafb7ad61af1197d4610e4
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
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
