Skip to content

Commit e21e2fb

Browse files
committed
Fixed documentation
1 parent f84ec2f commit e21e2fb

7 files changed

Lines changed: 622 additions & 65 deletions

File tree

docs/index.html

Lines changed: 589 additions & 57 deletions
Large diffs are not rendered by default.

fastadmin/models/base.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -415,7 +415,7 @@ def has_export_permission(self) -> bool:
415415
class InlineModelAdmin(BaseModelAdmin):
416416
"""This class is used to create admin inline model class."""
417417

418-
# The model which the inline is using. This is required.
418+
# The model class which the inline is using. This is required.
419419
model: Any
420420

421421
# The name of the foreign key on the model.

fastadmin/settings.py

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,22 +9,47 @@
99
class Settings(BaseSettings):
1010
"""Settings"""
1111

12+
# This value is the prefix you used for mounting FastAdmin app for FastAPI.
1213
ADMIN_PREFIX: str = "admin"
1314

15+
# This value is the site name on sign-in page and on header.
1416
ADMIN_SITE_NAME: str = "FastAdmin"
17+
18+
# This value is the logo path on sign-in page.
1519
ADMIN_SITE_SIGN_IN_LOGO: str = "/admin/static/images/sign-in-logo.svg"
20+
21+
# This value is the logo path on header.
1622
ADMIN_SITE_HEADER_LOGO: str = "/admin/static/images/header-logo.svg"
23+
24+
# This value is the favicon path.
1725
ADMIN_SITE_FAVICON: str = "/admin/static/images/favicon.png"
26+
27+
# This value is the primary color for FastAdmin.
1828
ADMIN_PRIMARY_COLOR: str = "#009485"
1929

30+
# This value is the session id key to store session id in http only cookies.
2031
ADMIN_SESSION_ID_KEY: str = "admin_session_id"
32+
33+
# This value is the expired_at period (in sec) for session id.
2134
ADMIN_SESSION_EXPIRED_AT: int = 144000 # in sec
35+
36+
# This value is the name for User db/orm model class for authentication.
2237
ADMIN_USER_MODEL: str
38+
39+
# This value is the username field for User db/orm model for for authentication.
2340
ADMIN_USER_MODEL_USERNAME_FIELD: str
41+
42+
# This value is the key to securing signed data - it is vital you keep this secure,
43+
# or attackers could use it to generate their own signed values.
2444
ADMIN_SECRET_KEY: str
2545

46+
# This value is the date format for JS widgets.
2647
ADMIN_DATE_FORMAT: str = "YYYY-MM-DD"
48+
49+
# This value is the datetime format for JS widgets.
2750
ADMIN_DATETIME_FORMAT: str = "YYYY-MM-DD HH:mm"
51+
52+
# This value is the time format for JS widgets.
2853
ADMIN_TIME_FORMAT: str = "HH:mm:ss"
2954

3055

fastadmin/static/css/main.min.css

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

fastadmin/static/css/main.min.css.map

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

fastadmin/static/js/main.min.js

Lines changed: 3 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

fastadmin/static/js/main.min.js.map

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)