From 2eee2715ada99149b53d441a718f2ba6710244ed Mon Sep 17 00:00:00 2001 From: long2ice Date: Sat, 1 May 2021 21:20:09 +0800 Subject: [PATCH] update docs --- docs/en/docs/getting_started/quick_start.md | 2 +- docs/en/docs/pro/{index.md => exclusive.md} | 16 +++++++++++----- docs/en/docs/pro/support.md | 4 ++++ docs/en/docs/reference/actions.md | 1 + docs/en/docs/reference/bulk_actions.md | 1 + docs/en/docs/reference/global_search.md | 1 + .../reference/{configuration.md => index.md} | 0 docs/en/mkdocs.yml | 10 +++++++--- 8 files changed, 26 insertions(+), 9 deletions(-) rename docs/en/docs/pro/{index.md => exclusive.md} (82%) create mode 100644 docs/en/docs/pro/support.md create mode 100644 docs/en/docs/reference/actions.md create mode 100644 docs/en/docs/reference/bulk_actions.md create mode 100644 docs/en/docs/reference/global_search.md rename docs/en/docs/reference/{configuration.md => index.md} (100%) diff --git a/docs/en/docs/getting_started/quick_start.md b/docs/en/docs/getting_started/quick_start.md index c061da2..a5f31cc 100644 --- a/docs/en/docs/getting_started/quick_start.md +++ b/docs/en/docs/getting_started/quick_start.md @@ -164,4 +164,4 @@ class Content(Dropdown): ### What's next? -That's all, you can run your app now. For more reference you can see [Reference](/reference). +That's all, you can run your app now. For more reference you can see [reference](/reference). diff --git a/docs/en/docs/pro/index.md b/docs/en/docs/pro/exclusive.md similarity index 82% rename from docs/en/docs/pro/index.md rename to docs/en/docs/pro/exclusive.md index 47ab08b..5d62e4b 100644 --- a/docs/en/docs/pro/index.md +++ b/docs/en/docs/pro/exclusive.md @@ -26,6 +26,17 @@ admin_app.add_middleware(BaseHTTPMiddleware, dispatch=LoginPasswordMaxTryMiddlew ## Error pages +### 403 + +You can catch all `403` error to show builtin `403` page. + +```python +from fastapi_admin.exceptions import forbidden_error_exception +from starlette.status import HTTP_403_FORBIDDEN + +admin_app.add_exception_handler(HTTP_403_FORBIDDEN, forbidden_error_exception) +``` + ### 404 You can catch all `404` error to show builtin `404` page. @@ -57,8 +68,3 @@ admin_app.configure(maintenance=True) ``` ## Admin Log - -## Free consultation - -Whenever you have any questions, you can send email to or open `issue` in `fastapi-admin-pro` -repository, I will answer your questions as soon as possible. diff --git a/docs/en/docs/pro/support.md b/docs/en/docs/pro/support.md new file mode 100644 index 0000000..246faba --- /dev/null +++ b/docs/en/docs/pro/support.md @@ -0,0 +1,4 @@ +# Support + +Whenever you have any questions, you can send email to or open `issue` in `fastapi-admin-pro` +repository for help, I will answer your questions as soon as possible. diff --git a/docs/en/docs/reference/actions.md b/docs/en/docs/reference/actions.md new file mode 100644 index 0000000..1060a65 --- /dev/null +++ b/docs/en/docs/reference/actions.md @@ -0,0 +1 @@ +# Actions diff --git a/docs/en/docs/reference/bulk_actions.md b/docs/en/docs/reference/bulk_actions.md new file mode 100644 index 0000000..5cb8482 --- /dev/null +++ b/docs/en/docs/reference/bulk_actions.md @@ -0,0 +1 @@ +# Bulk Actions diff --git a/docs/en/docs/reference/global_search.md b/docs/en/docs/reference/global_search.md new file mode 100644 index 0000000..2da60f5 --- /dev/null +++ b/docs/en/docs/reference/global_search.md @@ -0,0 +1 @@ +# Global Search (💗 Pro only) diff --git a/docs/en/docs/reference/configuration.md b/docs/en/docs/reference/index.md similarity index 100% rename from docs/en/docs/reference/configuration.md rename to docs/en/docs/reference/index.md diff --git a/docs/en/mkdocs.yml b/docs/en/mkdocs.yml index e1a9abf..7ca703a 100644 --- a/docs/en/mkdocs.yml +++ b/docs/en/mkdocs.yml @@ -40,7 +40,7 @@ nav: - getting_started/installation.md - getting_started/quick_start.md - Reference: - - reference/configuration.md + - reference/index.md - reference/resource.md - Widget: - reference/widget/filter.md @@ -50,16 +50,20 @@ nav: - reference/middleware.md - reference/permission.md - reference/admin_log.md - - Custom: + - reference/global_search.md + - reference/actions.md + - reference/bulk_actions.md + - Customization: - custom/page.md - custom/overwrite.md - custom/login.md - custom/file.md - custom/widget.md - Pro Version For Sponsor: - - pro/index.md - pro/sponsor.md + - pro/exclusive.md - pro/installation.md + - pro/support.md extra: alternate: - name: English