openstack
/
python-glanceclient
Code Issues Proposed changes

Use Sphinx 1.5 warning-is-error 

With pbr 2.0 and Sphinx 1.5, the setting for treat sphinx warnings as
errors is setting warning-is-error in build_sphinx section. Enable this.

Change-Id: I39ffb22c37a05f00cade2fbd14449eaf77dc3d39
This commit is contained in:
Stephen Finucane 2017-04-19 10:42:23 +01:00
parent bd42145923
commit 0e2e3f4372
2 changed files with 10 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
doc/source/man/glance.rst
View File

@ -23,26 +23,24 @@ Service (Glance).
In order to use the CLI, you must provide your OpenStack username, password, In order to use the CLI, you must provide your OpenStack username, password,
project (historically called tenant), and auth endpoint. You can use project (historically called tenant), and auth endpoint. You can use
configuration options :option:`--os-username`, :option:`--os-password`, configuration options ``--os-username``, ``--os-password``, ``--os-tenant-id``,
:option:`--os-tenant-id`, and :option:`--os-auth-url` or set corresponding and ``--os-auth-url`` or set corresponding environment variables::
environment variables::
export OS_USERNAME=user export OS_USERNAME=user
export OS_PASSWORD=pass export OS_PASSWORD=pass
export OS_TENANT_ID=b363706f891f48019483f8bd6503c54b export OS_TENANT_ID=b363706f891f48019483f8bd6503c54b
export OS_AUTH_URL=http://auth.example.com:5000/v2.0 export OS_AUTH_URL=http://auth.example.com:5000/v2.0
The command line tool will attempt to reauthenticate using provided The command line tool will attempt to reauthenticate using provided credentials
credentials for every request. You can override this behavior by manually for every request. You can override this behavior by manually supplying an auth
supplying an auth token using :option:`--os-image-url` and token using ``--os-image-url`` and ``--os-auth-token`` or by setting
:option:`--os-auth-token` or by setting corresponding environment variables:: corresponding environment variables::
export OS_IMAGE_URL=http://glance.example.org:9292/ export OS_IMAGE_URL=http://glance.example.org:9292/
export OS_AUTH_TOKEN=3bcc3d3a03f44e3d8377f9247b0ad155 export OS_AUTH_TOKEN=3bcc3d3a03f44e3d8377f9247b0ad155
You can select an API version to use by ``--os-image-api-version`` option or by
You can select an API version to use by :option:`--os-image-api-version` setting corresponding environment variable::
option or by setting corresponding environment variable::
export OS_IMAGE_API_VERSION=1 export OS_IMAGE_API_VERSION=1

3
setup.cfg
View File

@ -35,9 +35,10 @@ console_scripts =
[build_sphinx] [build_sphinx]
builders = html,man builders = html,man
all-files = 1
warning-is-error = 1
source-dir = doc/source source-dir = doc/source
build-dir = doc/build build-dir = doc/build
all_files = 1
[upload_sphinx] [upload_sphinx]
upload-dir = doc/build/html upload-dir = doc/build/html