diff --git a/docs/README.rst b/docs/README.rst index 3a2e9de..4bd3d2c 100644 --- a/docs/README.rst +++ b/docs/README.rst @@ -1,35 +1,33 @@ -.. _swh-auth: - Software Heritage - Authentication ================================== ``swh-auth`` is a set of utility libraries related to user authentication in applications and services based on the use of `Keycloak`_ and `OpenID Connect`_. `Keycloak`_ is an open source software enabling single sign-on (SSO) with identity and access management. `OpenID Connect`_ (OIDC) is an authentication layer on top of `OAuth 2.0`_, widely used in modern web applications and services. ``swh-auth`` notably offers the following features: - the ``swh.auth.keycloak.KeycloakOpenIDConnect`` class to ease the interaction with a Keycloak server - a ``pytest`` plugin with the ``keycloak_oidc`` fixture to mock Keycloak responses in unit tests - generic backends, views and middlewares to easily plug OpenID Connect authentication in any `Django`_ or `Django REST framework`_ application .. _Keycloak: https://www.keycloak.org/ .. _OpenID Connect: https://openid.net/connect/ .. _OAuth 2.0: https://oauth.net/2/ .. _Django: https://www.djangoproject.com/ .. _Django REST framework: https://www.django-rest-framework.org/ \ No newline at end of file diff --git a/docs/index.rst b/docs/index.rst index 3851027..c8f7297 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,10 +1,12 @@ +.. _swh-auth: + .. include:: README.rst Reference Documentation ----------------------- .. toctree:: :maxdepth: 2 django /apidoc/swh.auth