diff options
| author | Stephen Finucane <sfinucan@redhat.com> | 2017-08-22 11:41:50 +0100 |
|---|---|---|
| committer | Stephen Finucane <sfinucan@redhat.com> | 2017-08-22 11:41:50 +0100 |
| commit | 5d0b4bdc6e62c680dffb8aae8a1d95b869f89220 (patch) | |
| tree | 52b892252644982eeb59289667cc9d1ef9dda447 /doc/source/user | |
| parent | b7d34684607bbc0d8c507970661d0b1d3bed7843 (diff) | |
| download | python-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/user')
| -rw-r--r-- | doc/source/user/cinder.rst | 8 | ||||
| -rw-r--r-- | doc/source/user/shell.rst | 6 |
2 files changed, 7 insertions, 7 deletions
diff --git a/doc/source/user/cinder.rst b/doc/source/user/cinder.rst index 50fb644..cad6611 100644 --- a/doc/source/user/cinder.rst +++ b/doc/source/user/cinder.rst @@ -24,16 +24,16 @@ 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` +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 diff --git a/doc/source/user/shell.rst b/doc/source/user/shell.rst index 813b769..3bd2f1f 100644 --- a/doc/source/user/shell.rst +++ b/doc/source/user/shell.rst @@ -8,9 +8,9 @@ The :program:`cinder` shell utility interacts with the OpenStack Cinder API from the command line. It supports the entirety of the OpenStack Cinder API. You'll need to provide :program:`cinder` with your OpenStack username and -API key. You can do this with the :option:`--os-username`, :option:`--os-password` -and :option:`--os-tenant-name` options, but it's easier to just set them as -environment variables by setting two environment variables: +API key. You can do this with the `--os-username`, `--os-password` and +`--os-tenant-name` options, but it's easier to just set them as environment +variables by setting two environment variables: .. envvar:: OS_USERNAME or CINDER_USERNAME |