summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorStephen Finucane <sfinucan@redhat.com>2017-04-19 10:42:23 +0100
committerStephen Finucane <sfinucan@redhat.com>2017-04-20 09:40:15 +0100
commit0e2e3f4372cfccf0fad5c3d7a69d78040e025910 (patch)
treea19573ecc98dfeb7cc746c7be9775f0e7415f023 /doc
parentbd4214592334ecb67dd6da6c385bd4927419b4fd (diff)
downloadpython-glanceclient-0e2e3f4372cfccf0fad5c3d7a69d78040e025910.tar.gz
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
Diffstat (limited to 'doc')
-rw-r--r--doc/source/man/glance.rst18
1 files changed, 8 insertions, 10 deletions
diff --git a/doc/source/man/glance.rst b/doc/source/man/glance.rst
index 6b53903..8d3cac0 100644
--- a/doc/source/man/glance.rst
+++ b/doc/source/man/glance.rst
@@ -23,26 +23,24 @@ Service (Glance).
In order to use the CLI, you must provide your OpenStack username, password,
project (historically called tenant), and auth endpoint. You can use
-configuration options :option:`--os-username`, :option:`--os-password`,
-:option:`--os-tenant-id`, and :option:`--os-auth-url` or set corresponding
-environment variables::
+configuration options ``--os-username``, ``--os-password``, ``--os-tenant-id``,
+and ``--os-auth-url`` or set corresponding environment variables::
export OS_USERNAME=user
export OS_PASSWORD=pass
export OS_TENANT_ID=b363706f891f48019483f8bd6503c54b
export OS_AUTH_URL=http://auth.example.com:5000/v2.0
-The command line tool will attempt to reauthenticate using provided
-credentials for every request. You can override this behavior by manually
-supplying an auth token using :option:`--os-image-url` and
-:option:`--os-auth-token` or by setting corresponding environment variables::
+The command line tool will attempt to reauthenticate using provided credentials
+for every request. You can override this behavior by manually supplying an auth
+token using ``--os-image-url`` and ``--os-auth-token`` or by setting
+corresponding environment variables::
export OS_IMAGE_URL=http://glance.example.org:9292/
export OS_AUTH_TOKEN=3bcc3d3a03f44e3d8377f9247b0ad155
-
-You can select an API version to use by :option:`--os-image-api-version`
-option or by setting corresponding environment variable::
+You can select an API version to use by ``--os-image-api-version`` option or by
+setting corresponding environment variable::
export OS_IMAGE_API_VERSION=1