Update docs, bump version

David Farrington · David Farrington · commit 83fdfd40036d · 2020-06-05T11:48:09.000+01:00
diff --git a/README.md b/README.md
@@ -1,9 +1,21 @@
 # Django jazzmin (Jazzy Admin)
-Drop-in theme for django admin, that utilises AdminLTE & Bootstrap to make yo' admin looky jazzy
+Drop-in theme for django admin, that utilises AdminLTE 3 & Bootstrap 4 to make yo' admin looky jazzy
 
-This was initially a Fork of https://github.com/wuyue92tree/django-adminlte-ui that I refactored so much I thought it 
-deserved its own package, big thanks to @wuyue92tree for all of his initial hard work, I am still patching into that 
-project were possible, but this project is taking a slightly different direction.
+Support for custom or generated menus on the left or the top. 
+
+## Screenshots
+
+## Dashboard
+![dashboard](docs/dashboard.png)
+
+## List view
+![table list](docs/list_view.png)
+
+## Detail view
+![form page](docs/detail_view.png)
+
+## Login view
+![login](docs/login.png)
 
 ## Installation
 ```
@@ -12,6 +24,8 @@ pip install django-jazzmin
 
 ## Setup & configuration
 
+See the [test_app](./tests/test_app/settings.py) for a full implementation
+
 ```python
 # settings.py
 
@@ -24,70 +38,75 @@ INSTALLED_APPS = [
 
 
 JAZZMIN_SETTINGS = {
-    # Choose from black, black-light, blue, blue-light, green, green-light, purple, purple-light,
-    # red, red-light, yellow, yellow-light
-    'skin': 'blue',
-
     # title of the window
-    'site_title': 'Django Admin',
+    'site_title': 'Polls Admin',
 
     # Title on the login screen
-    'site_header': 'Django',
+    'site_header': 'Polls',
 
     # square logo to use for your site, must be present in static files, used for favicon and brand on top left
-    'site_logo': 'jazzmin/img/default-log.svg',
+    'site_logo': None,
 
     # Welcome text on the login screen
-    'welcome_sign': 'Welcome',
+    'welcome_sign': 'Welcome to polls',
 
     # Copyright on the footer
     'copyright': 'Acme Ltd',
 
-    # Wether to aut expand the menu
-    'navigation_expanded': True,
-
     # The model admin to search from the search bar, search bar omitted if excluded
-    'search_model': 'profiles.Profile',
+    'search_model': 'auth.User',
 
     # Field name on user model that contains avatar image
-    'user_avatar': 'avatar',
+    'user_avatar': None,
+
+    # Links to put along the top menu
+    'topmenu_links': [
+
+        # Url that gets reversed (Permissions can be added)
+        {'name': 'Home', 'url': 'admin:index', 'permissions': ['auth.view_user']},
 
-    # Hide these apps when generating menu
-    'hide_apps': ['auth'],
+        # external url that opens in a new window (Permissions can be added)
+        {'name': 'Support', 'url': 'https://github.com/farridav/django-jazzmin/issues', 'new_window': True},
 
-    # Hide these models when generating menu
-    'hide_models': ['auth.user'],
+        # model admin to link to (Permissions checked against model)
+        {'model': 'auth.User'},
 
-    # List of apps to base menu ordering off of
-    'order_with_respect_to': ['first_app', 'second_app'],
+        # App with dropdown menu to all its models pages (Permissions checked against models)
+        {'app': 'polls'},
+    ],
+
+    # Whether to display the side menu
+    'show_sidebar': True,
+
+    # Whether to aut expand the menu
+    'navigation_expanded': True,
+
+    # Hide these apps when generating side menu
+    'hide_apps': [],
+
+    # Hide these models when generating side menu
+    'hide_models': [],
+
+    # List of apps to base side menu ordering off of
+    'order_with_respect_to': ['accounts', 'polls'],
 
     # Custom links to append to app groups, keyed on app name
     'custom_links': {
-        'first_app': [
-            {'name': 'Custom link', 'url': '/', 'icon': 'fa-user', 'permissions': []}
-        ]
+        'polls': [{
+            'name': 'Make Messages', 'url': 'make_messages', 'icon': 'fa-comments',
+            'permissions': ['polls.view_polls']
+        }]
     },
 
+    # Custom icons per model in the side menu See https://www.fontawesomecheatsheet.com/font-awesome-cheatsheet-5x/
+    # for a list of icon classes
     'icons': {
-        'auth': 'fa-people',
         'auth.user': 'fa-user',
     }
 }
 ```
 
-## Screenshots
-
-## Login view
-![login](docs/login.png)
-
-## Dashboard
-![dashboard](docs/dashboard.png)
-
-## List view
-![table list](docs/list_view.png)
-
-## Detail view
-![form page](docs/detail_view.png)
-
 # Thanks
-- Original Package https://github.com/wuyue92tree/django-adminlte-ui
+This was initially a Fork of https://github.com/wuyue92tree/django-adminlte-ui that we refactored so much we thought it 
+deserved its own package, big thanks to @wuyue92tree for all of his initial hard work, we are still patching into that 
+project were possible, but this project is taking a slightly different direction.
diff --git a/README.rst b/README.rst
@@ -14,6 +14,9 @@ Installation
 
 Setup & configuration
 =====================
+
+See the test_app (https://github.com/farridav/django-jazzmin/tests/test_app/settings.py) for a full implementation
+
 ::
 
     # settings.py
@@ -27,52 +30,69 @@ Setup & configuration
 
 
     JAZZMIN_SETTINGS = {
-        # Choose from black, black-light, blue, blue-light, green, green-light, purple, purple-light,
-        # red, red-light, yellow, yellow-light
-        'skin': 'blue',
-
         # title of the window
-        'site_title': 'Django Admin',
+        'site_title': 'Polls Admin',
 
         # Title on the login screen
-        'site_header': 'Django',
+        'site_header': 'Polls',
 
         # square logo to use for your site, must be present in static files, used for favicon and brand on top left
-        'site_logo': 'jazzmin/img/default-log.svg',
+        'site_logo': None,
 
         # Welcome text on the login screen
-        'welcome_sign': 'Welcome',
+        'welcome_sign': 'Welcome to polls',
 
         # Copyright on the footer
         'copyright': 'Acme Ltd',
 
-        # Wether to aut expand the menu
-        'navigation_expanded': True,
-
         # The model admin to search from the search bar, search bar omitted if excluded
-        'search_model': 'profiles.Profile',
+        'search_model': 'auth.User',
 
         # Field name on user model that contains avatar image
-        'user_avatar': 'avatar',
+        'user_avatar': None,
+
+        # Links to put along the top menu
+        'topmenu_links': [
+
+            # Url that gets reversed (Permissions can be added)
+            {'name': 'Home', 'url': 'admin:index', 'permissions': ['auth.view_user']},
 
-        # Hide these apps when generating menu
-        'hide_apps': ['auth'],
+            # external url that opens in a new window (Permissions can be added)
+            {'name': 'Support', 'url': 'https://github.com/farridav/django-jazzmin/issues', 'new_window': True},
 
-        # Hide these models when generating menu
-        'hide_models': ['auth.user'],
+            # model admin to link to (Permissions checked against model)
+            {'model': 'auth.User'},
 
-        # List of apps to base menu ordering off of
-        'order_with_respect_to': ['first_app', 'second_app'],
+            # App with dropdown menu to all its models pages (Permissions checked against models)
+            {'app': 'polls'},
+        ],
+
+        # Whether to display the side menu
+        'show_sidebar': True,
+
+        # Whether to aut expand the menu
+        'navigation_expanded': True,
+
+        # Hide these apps when generating side menu
+        'hide_apps': [],
+
+        # Hide these models when generating side menu
+        'hide_models': [],
+
+        # List of apps to base side menu ordering off of
+        'order_with_respect_to': ['accounts', 'polls'],
 
         # Custom links to append to app groups, keyed on app name
         'custom_links': {
-            'first_app': [
-                {'name': 'Custom link', 'url': '/', 'icon': 'fa-user', 'permissions': []}
-            ]
+            'polls': [{
+                'name': 'Make Messages', 'url': 'make_messages', 'icon': 'fa-comments',
+                'permissions': ['polls.view_polls']
+            }]
         },
 
+        # Custom icons per model in the side menu See https://www.fontawesomecheatsheet.com/font-awesome-cheatsheet-5x/
+        # for a list of icon classes
         'icons': {
-            'auth': 'fa-people',
             'auth.user': 'fa-user',
         }
     }
@@ -85,4 +105,6 @@ See https://github.com/farridav/django-jazzmin
 
 Thanks
 ------
-- Original Package https://github.com/wuyue92tree/django-adminlte-ui
+This was initially a Fork of https://github.com/wuyue92tree/django-adminlte-ui that we refactored so much we thought it
+deserved its own package, big thanks to @wuyue92tree for all of his initial hard work, we are still patching into that
+project were possible, but this project is taking a slightly different direction.
diff --git a/jazzmin/__init__.py b/jazzmin/__init__.py
@@ -1,2 +1,2 @@
-version = '1.0.1'
+version = '2.0.0'
 default_app_config = 'jazzmin.apps.JazzminConfig'
diff --git a/jazzmin/settings.py b/jazzmin/settings.py
@@ -6,10 +6,6 @@
 from .utils import get_admin_url, get_custom_url, get_model_meta, get_app_admin_urls
 
 DEFAULT_SETTINGS = {
-    # Choose from black, black-light, blue, blue-light, green, green-light, purple, purple-light
-    # red, red-light, yellow, yellow-light
-    'skin': 'blue',
-
     # title of the window
     'site_title': AdminSite.site_title,
 
@@ -56,9 +52,9 @@
     # Custom links to append to app groups, keyed on app name
     'custom_links': {},
 
-    # Custom icons per app or model
+    # Custom icons per model in the side menu See https://www.fontawesomecheatsheet.com/font-awesome-cheatsheet-5x/
+    # for a list of icon classes
     'icons': {
-        'auth': 'fa-people',
         'auth.user': 'fa-user',
     }
 }
diff --git a/setup.py b/setup.py
@@ -19,6 +19,6 @@
     zip_safe=False,
     entry_points={},
     install_requires=[
-        'django>=1.7',
+        'django>=2',
     ]
 )
diff --git a/tests/test_app/settings.py b/tests/test_app/settings.py
@@ -37,24 +37,28 @@
 ROOT_URLCONF = 'tests.test_app.urls'
 
 JAZZMIN_SETTINGS = {
-    'skin': 'blue',
+    # title of the window
     'site_title': 'Polls Admin',
+
+    # Title on the login screen
     'site_header': 'Polls',
+
+    # square logo to use for your site, must be present in static files, used for favicon and brand on top left
     'site_logo': None,
+
+    # Welcome text on the login screen
     'welcome_sign': 'Welcome to polls',
+
+    # Copyright on the footer
     'copyright': 'Acme Ltd',
-    'navigation_expanded': True,
+
+    # The model admin to search from the search bar, search bar omitted if excluded
     'search_model': 'auth.User',
+
+    # Field name on user model that contains avatar image
     'user_avatar': None,
-    'hide_apps': [],
-    'hide_models': [],
-    'order_with_respect_to': ['accounts', 'polls'],
-    'custom_links': {
-        'polls': [{
-            'name': 'Make Messages', 'url': 'make_messages', 'icon': 'fa-comments',
-            'permissions': ['polls.view_polls']
-        }]
-    },
+
+    # Links to put along the top menu
     'topmenu_links': [
 
         # Url that gets reversed (Permissions can be added)
@@ -69,8 +73,33 @@
         # App with dropdown menu to all its models pages (Permissions checked against models)
         {'app': 'polls'},
     ],
+
+    # Whether to display the side menu
+    'show_sidebar': True,
+
+    # Whether to aut expand the menu
+    'navigation_expanded': True,
+
+    # Hide these apps when generating side menu
+    'hide_apps': [],
+
+    # Hide these models when generating side menu
+    'hide_models': [],
+
+    # List of apps to base side menu ordering off of
+    'order_with_respect_to': ['accounts', 'polls'],
+
+    # Custom links to append to app groups, keyed on app name
+    'custom_links': {
+        'polls': [{
+            'name': 'Make Messages', 'url': 'make_messages', 'icon': 'fa-comments',
+            'permissions': ['polls.view_polls']
+        }]
+    },
+
+    # Custom icons per model in the side menu See https://www.fontawesomecheatsheet.com/font-awesome-cheatsheet-5x/
+    # for a list of icon classes
     'icons': {
-        'auth': 'fa-people',
         'auth.user': 'fa-user',
     }
 }
diff --git a/tests/test_utils.py b/tests/test_utils.py

Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,2 @@`
`1`		`-version = '1.0.1'`
	`1`	`+version = '2.0.0'`
`2`	`2`	`default_app_config = 'jazzmin.apps.JazzminConfig'`
Original file line number	Diff line number	Diff line change
`@@ -19,6 +19,6 @@`
`19`	`19`	`zip_safe=False,`
`20`	`20`	`entry_points={},`
`21`	`21`	`install_requires=[`
`22`		`- 'django>=1.7',`
	`22`	`+ 'django>=2',`
`23`	`23`	`]`
`24`	`24`	`)`