Merge branch 'main' into do-not-join-same-model-twice-in-search-query

aminalaee · web-flow · commit d5a3edf984a2 · 2025-05-26T10:26:14.000+02:00
diff --git a/README.md b/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)
 
diff --git a/docs/authentication.md b/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
diff --git a/docs/configurations.md b/docs/configurations.md
@@ -226,6 +226,10 @@ The forms are based on `WTForms` package and include the following options:
         form_edit_rules = ["name"]
     ```
 
+### Related models
+
+To define how related model is displayed in the dropdown, `__str__` method must be difined in the related model.
+
 ## Export options
 
 SQLAdmin supports exporting data in the list page. Currently only CSV export is supported.
diff --git a/docs/index.md b/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)
 
diff --git a/docs/model_convertors.md b/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
diff --git a/docs/working_with_files.md b/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).
diff --git a/mkdocs.yml b/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"
diff --git a/pyproject.toml b/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]
diff --git a/sqladmin/_menu.py b/sqladmin/_menu.py
@@ -44,7 +44,7 @@ def type_(self) -> str:
 class CategoryMenu(ItemMenu):
     def is_active(self, request: Request) -> bool:
         return any(
-            c.is_visible(request) and c.is_accessible(request) for c in self.children
+            c.is_active(request) and c.is_accessible(request) for c in self.children
         )
 
     @property
diff --git a/sqladmin/application.py b/sqladmin/application.py
@@ -638,7 +638,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:
diff --git a/sqladmin/authentication.py b/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.
         """
diff --git a/sqladmin/templates/sqladmin/_macros.html b/sqladmin/templates/sqladmin/_macros.html
@@ -1,5 +1,5 @@
 {% macro menu_category(menu, request) %}
-{% if menu.is_active(request) %}
+{% if menu.is_visible(request) and menu.is_accessible(request) %}
 <li class="nav-item dropdown">
   <a class="nav-link dropdown-toggle {% if menu.is_active(request) %}active{% endif %}" data-bs-toggle="dropdown"
     href="#">
diff --git a/tests/test_menu.py b/tests/test_menu.py
@@ -42,6 +42,32 @@ def test_category_menu():
     assert item_menu.type_ == "Category"
 
 
+def test_category_menu_is_active_when_child_is_active():
+    request = Request(
+        {
+            "type": "http",
+            "path_params": {"identity": "user"},
+        }
+    )
+    user_menu = ViewMenu(view=UserAdmin(), name="user")
+
+    category_menu = CategoryMenu(name="Models")
+    category_menu.add_child(user_menu)
+
+    assert user_menu.is_active(request) is True
+    assert category_menu.is_active(request) is True
+
+
+def test_category_menu_is_not_active_when_no_child_is_active():
+    user_menu = ViewMenu(view=UserAdmin(), name="user")
+
+    category_menu = CategoryMenu(name="Models")
+    category_menu.add_child(user_menu)
+
+    assert user_menu.is_active(request) is False
+    assert category_menu.is_active(request) is False
+
+
 def test_view_menu():
     item_menu = ViewMenu(view=UserAdmin(), name="view")
 

Original file line number	Diff line number	Diff line change
`@@ -57,4 +57,4 @@ and displayed in the admin dashboard.`
`57`	`57`
`58`	`58`	You can replace `FileSystemStorage` with `S3Storage` to upload to S3 or any S3-compatible API.
`59`	`59`
`60`		-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).
	`60`	+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).
Original file line number	Diff line number	Diff line change
`@@ -44,7 +44,7 @@ def type_(self) -> str:`
`44`	`44`	`class CategoryMenu(ItemMenu):`
`45`	`45`	`def is_active(self, request: Request) -> bool:`
`46`	`46`	`return any(`
`47`		`- c.is_visible(request) and c.is_accessible(request) for c in self.children`
	`47`	`+ c.is_active(request) and c.is_accessible(request) for c in self.children`
`48`	`48`	`)`
`49`	`49`
`50`	`50`	`@property`