doc: mirror readme and html now builds again

Author: samedii

docs/conf.py

@@ -13,7 +13,7 @@
 # import os
 # import sys
 # sys.path.insert(0, os.path.abspath('.'))
-
+from typing import List
 
 # -- Project information -----------------------------------------------------
 
@@ -51,4 +51,4 @@
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ["_static"]
+html_static_path: List[str] = []

docs/index.rst

@@ -1,11 +1,19 @@
 Welcome to fastapi-oidc's documentation!
 ========================================
 
-Verify ID Tokens Issued by Third Party
+Verify and decrypt 3rd party OpenID Connect tokens to protect your
+`FastAPI <https://github.com/tiangolo/fastapi>`_ endpoints.
 
-This is great if you just want to use something like Okta or google to handle
-your auth. All you need to do is verify the token and then you can extract
-user ID info from it.
+Easily used with authenticators such as:
+
+- `Keycloak <https://www.keycloak.org/>`_ (open source)
+- `SuperTokens <https://supertokens.io/>`_ (open source)
+- `Auth0 <https://auth0.com/>`_
+- `Okta <https://www.okta.com/products/authentication/>`_
+
+
+FastAPI's generated interactive documentation supports the grant flows
+``authorization_code``, ``implicit``, ``password`` and ``client_credentials``.
 
 .. toctree::
    :maxdepth: 2

fastapi_oidc/auth.py

@@ -1,14 +1,14 @@
 # -*- coding: utf-8 -*-
 """
-Module for validating OIDC ID Tokens. Configured via config.py 
+Module for validating Open ID Connect ID Tokens.
 
 Usage
 =====
 
 .. code-block:: python3
 
     # This assumes you've already configured get_auth in your_app.py
-    from you_app.auth import authenticate_user
+    from your_app.auth import authenticate_user
 
     @app.get("/auth")
     def test_auth(authenticated_user: AuthenticatedUser = Depends(authenticate_user)):
@@ -37,16 +37,15 @@ def get_auth(
     audience: Optional[str] = None,
     signature_cache_ttl: int = 3600,
 ) -> Callable[[str], Dict]:
-    """Take configurations and return the authenticate_user function.
+    """Take configurations and returns the :func:`authenticate_user` function.
 
     This function should only be invoked once at the beggining of your
     server code. The function it returns should be used to check user credentials.
 
     Args:
         openid_connect_url (URL): URL to the "well known" openid connect config
             e.g. https://dev-123456.okta.com/.well-known/openid-configuration
-        issuer (URL): Same as base_authorization. This is used to generating OpenAPI3.0
-            docs which is broken (in OpenAPI/FastAPI) right now.
+        issuer (URL): (Optional) The issuer URL from your auth server.
         audience (str): (Optional) The audience string configured by your auth server.
         signature_cache_ttl (int): How many seconds your app should cache the
             authorization server's public signatures.