summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorBrant Knudson <bknudson@us.ibm.com>2014-06-12 14:30:07 -0500
committerBrant Knudson <bknudson@us.ibm.com>2014-06-12 14:30:07 -0500
commit03fbe590ebf7c769bd3334a7daaa3eafe43f99dd (patch)
tree9441f91f57d17244d0d5e3e55f9304dfc9b04fd1 /doc
parent832d89681cd1c2470375a10d87018be7bf8d0ed9 (diff)
downloadpython-keystoneclient-03fbe590ebf7c769bd3334a7daaa3eafe43f99dd.tar.gz
Link to docstrings in using-api-v3
The references to classes and modules were just the names and didn't link to the docstrings for the class or module. With this change, names are now links to the class or module. Change-Id: I9c7c03e8221ca71c7fddc0682abadc7a78d371db
Diffstat (limited to 'doc')
-rw-r--r--doc/source/using-api-v3.rst18
1 files changed, 10 insertions, 8 deletions
diff --git a/doc/source/using-api-v3.rst b/doc/source/using-api-v3.rst
index bf2c727..814f16f 100644
--- a/doc/source/using-api-v3.rst
+++ b/doc/source/using-api-v3.rst
@@ -19,13 +19,13 @@ The main concepts in the Identity v3 API are:
* trusts
* users
-The ``keystoneclient.v3.client`` API lets you query and make changes
+The :py:mod:`keystoneclient.v3.client` API lets you query and make changes
through ``managers``. For example, to manipulate a project (formerly
called tenant), you interact with a
-``keystoneclient.v3.projects.ProjectManager`` object.
+:py:class:`keystoneclient.v3.projects.ProjectManager` object.
You obtain access to managers through attributes of a
-``keystoneclient.v3.client.Client`` object. For example, the
+:py:class:`keystoneclient.v3.client.Client` object. For example, the
``projects`` attribute of a ``Client`` object is a projects manager::
>>> from keystoneclient.v3 import client
@@ -33,10 +33,11 @@ You obtain access to managers through attributes of a
>>> keystone.projects.list() # List projects
While it is possible to instantiate a
-``keystoneclient.v3.client.Client`` object (as done above for
+:py:class:`keystoneclient.v3.client.Client` object (as done above for
clarity), the recommended approach is to use the discovery mechanism
-provided by the ``keystone.client.Client`` class. The appropriate
-class will be instantiated depending on the API versions available::
+provided by the :py:class:`keystoneclient.client.Client` class. The
+appropriate class will be instantiated depending on the API versions
+available::
>>> from keystoneclient import client
>>> keystone =
@@ -70,13 +71,14 @@ as the auth_url keyword argument::
>>> type(keystone)
<class 'keystoneclient.v3.client.Client'>
-Upon successful authentication, a ``keystoneclient.v3.client.Client``
+Upon successful authentication, a :py:class:`keystoneclient.v3.client.Client`
object is returned (when using the Identity v3 API). Authentication and
examples of common tasks are provided below.
You can generally expect that when the client needs to propagate an
exception it will raise an instance of subclass of
-``keystoneclient.exceptions.ClientException``
+``keystoneclient.exceptions.ClientException`` (see
+:py:class:`keystoneclient.openstack.common.apiclient.exceptions.ClientException`)
Authenticating
==============