diff options
| author | JUN JIE NAN <nanjj@cn.ibm.com> | 2013-12-23 10:20:58 +0800 |
|---|---|---|
| committer | JUN JIE NAN <nanjj@cn.ibm.com> | 2014-01-02 13:22:52 +0800 |
| commit | e2d7ebff7ebde4d5d7f64440c1d550153466768b (patch) | |
| tree | f241eaad3285ba9475c89bf48ade0f2ff2d4a1ee /doc | |
| parent | 39ca592c557ccd315cd21afb90757b2cbafdc9e5 (diff) | |
| download | python-heatclient-e2d7ebff7ebde4d5d7f64440c1d550153466768b.tar.gz | |
Wrapped some long lines
Some lines has been wrapped some not. So wrapped the left long lines.
Change-Id: I67b40e580b53cb7dca40112b3a3c112c359893dd
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/source/index.rst | 23 |
1 files changed, 17 insertions, 6 deletions
diff --git a/doc/source/index.rst b/doc/source/index.rst index 4ff24dc..aeb15ec 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -8,7 +8,8 @@ This is a client for OpenStack Heat API. There's a Python API Python API ========== -In order to use the python api directly, you must first obtain an auth token and identify which endpoint you wish to speak to:: +In order to use the python api directly, you must first obtain an auth +token and identify which endpoint you wish to speak to:: >>> tenant_id = 'b363706f891f48019483f8bd6503c54b' >>> heat_url = 'http://heat.example.org:8004/v1/%s' % tenant_id @@ -22,19 +23,28 @@ Once you have done so, you can use the API like so:: Command-line Tool ================= -In order to use the CLI, you must provide your OpenStack username, password, tenant, and auth endpoint. Use the corresponding configuration options (``--os-username``, ``--os-password``, ``--os-tenant-id``, and ``--os-auth-url``) or set them in environment variables:: +In order to use the CLI, you must provide your OpenStack username, +password, tenant, and auth endpoint. Use the corresponding +configuration options (``--os-username``, ``--os-password``, +``--os-tenant-id``, and ``--os-auth-url``) or set them in 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 your provided credentials for every request. You can override this behavior by manually supplying an auth token using ``--heat-url`` and ``--os-auth-token``. You can alternatively set these environment variables:: +The command line tool will attempt to reauthenticate using your +provided credentials for every request. You can override this behavior +by manually supplying an auth token using ``--heat-url`` and +``--os-auth-token``. You can alternatively set these environment +variables:: export HEAT_URL=http://heat.example.org:8004/v1/b363706f891f48019483f8bd6503c54b export OS_AUTH_TOKEN=3bcc3d3a03f44e3d8377f9247b0ad155 -Once you've configured your authentication parameters, you can run ``heat help`` to see a complete listing of available commands. +Once you've configured your authentication parameters, you can run +``heat help`` to see a complete listing of available commands. Man Pages ========= @@ -46,9 +56,10 @@ Man Pages Contributing ============ + Code is hosted `on GitHub`_. Submit bugs to the Heat project on -`Launchpad`_. Submit code to the openstack/python-heatclient project using -`Gerrit`_. +`Launchpad`_. Submit code to the openstack/python-heatclient project +using `Gerrit`_. .. _on GitHub: https://github.com/openstack/python-heatclient .. _Launchpad: https://launchpad.net/python-heatclient |