Merge "Update Documentation"

README.rst

@@ -2,7 +2,12 @@
 django-openstack-auth-kerberos
 ==============================
 
-Kerberos login to the OpenStack dashboard
+django-openstack-auth-kerberos provides a way to extend `django-openstack-auth
+<https://github.com/openstack/django_openstack_auth>`_ to allow kerberos login
+via S4U2 Proxy. It separates the code and additional dependencies required so
+that they are not required as part of the base DOA requirements.
+
+For installation instructions please consult the docs.
 
 * Free software: Apache license
 * Documentation: http://docs.openstack.org/developer/django-openstack-auth-kerberos

doc/source/api.rst

@@ -1,12 +0,0 @@
-=====
- API
-=====
-
-.. Use autodoc directives to describe the *public* modules and classes
-   in the library.
-
-   If the modules are completely unrelated, create an api subdirectory
-   and use a separate file for each (see oslo.utils).
-
-   If there is only one submodule, a single api.rst file like this
-   sufficient (see oslo.i18n).

doc/source/index.rst

@@ -11,8 +11,6 @@ Contents
    :maxdepth: 2
 
    installation
-   api
-   usage
    contributing
    history
 

doc/source/usage.rst

@@ -1,7 +0,0 @@
-=======
- Usage
-=======
-
-To use django-openstack-auth-kerberos in a project::
-
-    import django-openstack-auth-kerberos