summaryrefslogtreecommitdiff
path: root/doc/source/cli
diff options
context:
space:
mode:
authorStephen Finucane <sfinucan@redhat.com>2017-08-22 11:41:50 +0100
committerStephen Finucane <sfinucan@redhat.com>2017-08-22 11:41:50 +0100
commit5d0b4bdc6e62c680dffb8aae8a1d95b869f89220 (patch)
tree52b892252644982eeb59289667cc9d1ef9dda447 /doc/source/cli
parentb7d34684607bbc0d8c507970661d0b1d3bed7843 (diff)
downloadpython-cinderclient-5d0b4bdc6e62c680dffb8aae8a1d95b869f89220.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. Migrate the setting from the old warnerrors one. Change-Id: Ifd411ead74497a43ab22c57090ece2e1c7cfddb5
Diffstat (limited to 'doc/source/cli')
-rw-r--r--doc/source/cli/index.rst10
1 files changed, 5 insertions, 5 deletions
diff --git a/doc/source/cli/index.rst b/doc/source/cli/index.rst
index 96e0fd5..69bcd14 100644
--- a/doc/source/cli/index.rst
+++ b/doc/source/cli/index.rst
@@ -24,17 +24,17 @@ Storage Service (Cinder).
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-name` or :option:`--os-tenant-id`, and
-:option:`--os-auth-url` or set corresponding environment variables::
+configuration options `--os-username`, `--os-password`, `--os-tenant-name` or
+`--os-tenant-id`, and `--os-auth-url` or set corresponding environment
+variables::
export OS_USERNAME=user
export OS_PASSWORD=pass
export OS_TENANT_NAME=myproject
export OS_AUTH_URL=http://auth.example.com:5000/v2.0
-You can select an API version to use by :option:`--os-volume-api-version`
-option or by setting corresponding environment variable::
+You can select an API version to use by `--os-volume-api-version` option or by
+setting corresponding environment variable::
export OS_VOLUME_API_VERSION=2