Merge branch 'main' into feature/sqladmin-912_perform_template_context

Author: aminalaee

README.md

@@ -39,7 +39,7 @@ Main features include:
 
 ---
 
-**Documentation**: [https://aminalaee.dev/sqladmin](https://aminalaee.dev/sqladmin)
+**Documentation**: [https://aminalaee.github.io/sqladmin](https://aminalaee.github.io/sqladmin)
 
 **Source Code**: [https://github.com/aminalaee/sqladmin](https://github.com/aminalaee/sqladmin)
 

docs/authentication.md

@@ -10,7 +10,7 @@ The class `AuthenticationBackend` has three methods you need to override:
 
 * `authenticate`: Will be called for validating each incoming request.
 * `login`: Will be called only in the login page to validate username/password.
-* `logout`: Will be called only for the logout, usually clearin the session.
+* `logout`: Will be called only for the logout, usually clearing the session.
 
 ```python
 from sqladmin import Admin

docs/index.md

@@ -39,7 +39,7 @@ Main features include:
 
 ---
 
-**Documentation**: [https://aminalaee.dev/sqladmin](https://aminalaee.dev/sqladmin)
+**Documentation**: [https://aminalaee.github.io/sqladmin](https://aminalaee.github.io/sqladmin)
 
 **Source Code**: [https://github.com/aminalaee/sqladmin](https://github.com/aminalaee/sqladmin)
 

docs/model_convertors.md

@@ -4,8 +4,6 @@
 
 Model Converters are special classes used to convert SQLAlchemy model properties into web interface form fields. They allow you to customize how backend SQLAlchemy models are represented in the admin interface, providing flexibility in handling different data types and validation rules.
 
-This page will guide you through the basics of using and customizing Model Converters. For advanced usage, refer to the [API Reference](./api_reference/model_converter.md).
-
 ---
 
 ## Overview

docs/working_with_files.md

@@ -57,4 +57,4 @@ and displayed in the admin dashboard.
 
 You can replace `FileSystemStorage` with `S3Storage` to upload to S3 or any S3-compatible API.
 
-For complete features and API reference of the `fastapi-storages` you can visit the docs at [https://aminalaee.dev/fastapi-storages](https://aminalaee.dev/fastapi-storages).
+For complete features and API reference of the `fastapi-storages` you can visit the docs at [https://aminalaee.github.io/fastapi-storages](https://aminalaee.github.io/fastapi-storages).

mkdocs.yml

@@ -1,6 +1,6 @@
 site_name: SQLAlchemy Admin
 site_description: Flexible admin dashboard for SQLAlchemy.
-site_url: https://aminalaee.dev/sqladmin
+site_url: https://aminalaee.github.io/sqladmin/
 
 theme:
   name: "material"

pyproject.toml

@@ -41,7 +41,7 @@ full = [
 ]
 
 [project.urls]
-Documentation = "https://aminalaee.dev/sqladmin"
+Documentation = "https://aminalaee.github.io/sqladmin/"
 Issues = "https://github.com/aminalaee/sqladmin/issues"
 Source = "https://github.com/aminalaee/sqladmin"
 
@@ -93,9 +93,9 @@ dependencies = [
 
 [tool.hatch.envs.docs]
 dependencies = [
-  "mkdocs-material==9.1.3",
-  "mkdocs==1.4.2",
-  "mkdocstrings[python]==0.25.0",
+  "mkdocs-material==9.6.14",
+  "mkdocs==1.6.1",
+  "mkdocstrings[python]==0.26.1",
 ]
 
 [tool.hatch.envs.test.scripts]

sqladmin/application.py

@@ -644,7 +644,11 @@ async def login(self, request: Request) -> Response:
     async def logout(self, request: Request) -> Response:
         assert self.authentication_backend is not None
 
-        await self.authentication_backend.logout(request)
+        response = await self.authentication_backend.logout(request)
+
+        if isinstance(response, Response):
+            return response
+
         return RedirectResponse(request.url_for("admin:index"), status_code=302)
 
     async def ajax_lookup(self, request: Request) -> Response:

sqladmin/authentication.py

@@ -29,9 +29,13 @@ async def login(self, request: Request) -> bool:
         """
         raise NotImplementedError()
 
-    async def logout(self, request: Request) -> bool:
+    async def logout(self, request: Request) -> Response | bool:
         """Implement logout logic here.
         This will usually clear the session with `request.session.clear()`.
+
+        If a `Response` or `RedirectResponse` is returned,
+        that response is returned to the user,
+        otherwise the user will be redirected to the index page.
         """
         raise NotImplementedError()
 
@@ -40,7 +44,7 @@ async def authenticate(self, request: Request) -> Response | bool:
         This method will be called for each incoming request
         to validate the authentication.
 
-        If a 'Response' or `RedirectResponse` is returned,
+        If a `Response` or `RedirectResponse` is returned,
         that response is returned to the user,
         otherwise a True/False is expected.
         """