From 73b1e66a16ff8d5816470613d8acb8cffbb4d6b3 Mon Sep 17 00:00:00 2001
From: Brant Knudson <bknudson@us.ibm.com>
Date: Tue, 1 Mar 2016 13:59:38 -0600
Subject: [PATCH] Improve usability of docs

There's several references to BaseAuthPlugin, unfortunately the
docs for BaseAuthPlugin didn't lead to anywhere useful. Added
links to the implementations so developers know what to do next.

Change-Id: I8cf0f54cdec358238774636ba1d42f11e7ace555
---
 keystoneauth1/identity/__init__.py | 12 ++++++++++++
 keystoneauth1/plugin.py            |  8 +++++++-
 2 files changed, 19 insertions(+), 1 deletion(-)

diff --git a/keystoneauth1/identity/__init__.py b/keystoneauth1/identity/__init__.py
index 6ad88e41..b4f6ccd4 100644
--- a/keystoneauth1/identity/__init__.py
+++ b/keystoneauth1/identity/__init__.py
@@ -20,16 +20,28 @@ from keystoneauth1.identity.v3 import oidc
 BaseIdentityPlugin = base.BaseIdentityPlugin
 
 V2Password = v2.Password
+"""See :class:`keystoneauth1.identity.v2.Password`"""
+
 V2Token = v2.Token
+"""See :class:`keystoneauth1.identity.v2.Token`"""
 
 V3Password = v3.Password
+"""See :class:`keystoneauth1.identity.v3.Password`"""
+
 V3Token = v3.Token
+"""See :class:`keystoneauth1.identity.v3.Token`"""
 
 Password = generic.Password
+"""See :class:`keystoneauth1.identity.generic.Password`"""
+
 Token = generic.Token
+"""See :class:`keystoneauth1.identity.generic.Token`"""
 
 V3OidcPassword = oidc.OidcPassword
+"""See :class:`keystoneauth1.identity.v3.oidc.OidcPassword`"""
+
 V3OidcAuthorizationCode = oidc.OidcAuthorizationCode
+"""See :class:`keystoneauth1.identity.v3.oidc.OidcAuthorizationCode`"""
 
 __all__ = ('BaseIdentityPlugin',
            'Password',
diff --git a/keystoneauth1/plugin.py b/keystoneauth1/plugin.py
index cad12708..aa5171ad 100644
--- a/keystoneauth1/plugin.py
+++ b/keystoneauth1/plugin.py
@@ -19,7 +19,13 @@ IDENTITY_AUTH_HEADER_NAME = 'X-Auth-Token'
 
 
 class BaseAuthPlugin(object):
-    """The basic structure of an authentication plugin."""
+    """The basic structure of an authentication plugin.
+
+    .. note::
+        See :doc:`/authentication-plugins` for a description of plugins
+        provided by this library.
+
+    """
 
     def get_token(self, session, **kwargs):
         """Obtain a token.