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.