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
This adds release notes for the folowing commits:
$ git log --oneline --no-merges 0.14.2..HEAD
9a4d858 Support Pagination for namespace list
3989cd2 Support schema types with non-str value
9829d7b Don't require version to create Client instance
8e02b2a Allow --file in image-create with v2 Image API
d5a0e65 Add useful error on invalid --os-image-api-version
49f38a4 Add release notes for 0.14.0 - 0.14.2
5080d10 Send `identity_headers` through the wire
d0851c3 Remove readonly options from v2 shell commands
4194a55 Add --property-filter option to v2 image-list
ef0abdc Fix py34 failure for glance client
8c159a2 Don't set X-Auth-Token key in http session header if no token provided
b83a672 Refactor method of constructing dicts in some tests
751e064 Adds tty password entry for glanceclient
597da8a '--public' ignored on image create
cbbfbc9 Fix to ensure endpoint_type is used by _get_endpoint()
12a3a82 Add bash completion to glance client
Change-Id: I24fbba80831c311b42d1abb08487cc29c8b5b162
These were not written at the time of release, so this catches up with
the latest version.
For reference:
$ git log --oneline --no-merges 0.13.0..0.14.0
33dcea8 Support for Metadata Definitions Catalog API
16077d9 Catch new urllib3 exception: ProtocolError
6dda6f3 Fix error when logging http response with python 3
d6498b6 Ensure server's SSL cert is validated
9a53c1f Enable osprofiler interface in glanceclient shell
69361a1 Hide stderr noise in test output
1dfce53 Remove deprecated commands from shell
867e4ca Normalize glanceclient requested service url
4494853 Fix glance-client to work with IPv6 controllers
f15dc6b Add support for Keystone v3
7736349 Update theme for docs
e79031b Add a tox job for generating docs
68c1d1f Don't stream non-binary requests
f75a810 Use a correctly formatted example location in help
dbb242b Replace old httpclient with requests
1db17aa Enable F841
797d101 Resolving the performance issue for image listing of v2 API
e305dad Add profiling support to glanceclinet
9b9f3be Use immutable arg rather mutable arg
1c46c76 Add CONTRIBUTING.rst
$ git log --oneline --no-merges 0.14.0..0.14.1 f980fc5 Update how tokens are redacted
ba19a53 Handle UnicodeDecodeError in log_http_response
4d6b94a Print traceback to stderr if --debug is set
61e4eba Updated from global requirements
97b1506 Fix v2 requests to non-bleeding edge servers
9fbc313 Work toward Python 3.4 support and testing
d97f03e Import missing gettextutils._ in shell.py
4631b76 Fix indentation in tox.ini
cda8c4d Downgrade log message for http request failures
8770586 CLI image-update gives a wrong help on '--tags' param
$ git log --oneline --no-merges 0.14.1..0.14.2
052904b Don't replace the https handler in the poolmanager
5f4966d Remove network_utils
2b567cf Skip non-base properties in patch method
7ef1b7c Adds support for Glance Tasks calls
1511c86 Fix the ordering of assertEqual arguments
ab07caf Stop using intersphinx
929a72e Default to system CA bundle if no CA certificate is provided
Change-Id: Ie4195fa9ad7f5f45c387fda4b1db4fbce7a3f98c
Remove intersphinx from the docs build as it triggers network calls that
occasionally fail, and we don't really use intersphinx (links other
sphinx documents out on the internet)
This also removes the requirement for internet access during docs build.
This can cause docs jobs to fail if the project errors out on
warnings.
Change-Id: I71e941e2a639641a662a163c682eb86d51de42fb
Related-Bug: #1368910
The current developer docs theme used is out of sync with the other
openstack projects. This patch will update the docs to provide a more
consistent look and feel when using developer docs
Change-Id: I4a59f194bd0fc8c86c6d3c6b8cadb839a5158935
Provide basic but hopefully useful man page.
Also update OpenStack LCC to OpenStack Foundation in docs.
Resolves: bug 1193111
Implements blueprint: clients-man-pages
Change-Id: I9502b3d5ca75149d747d523934a6401e435924b7
* The index page is now a set of release notes and a quickstart guide
* Shrink the README (pypi doc page) and move it into the doc site
* Drop the link to the autoindex module docs
Change-Id: I276b1228ba4006279c112eb487dcde9e45c4f344
Ian Wienand