Docs Admin + Config

Author: samialfattani

doc/advanced.rst

@@ -315,6 +315,9 @@ Some of the Geometry field types that are available include:
 Have a look at https://github.com/pallets-eco/flask-admin/tree/master/examples/geo-alchemy
 to get started.
 
+
+.. _display-map-widgets:
+
 Display map widgets
 *******************
 
@@ -719,6 +722,8 @@ While the wrapped function should accept only one parameter - `ids`::
                 flash(gettext('Failed to approve users. %(error)s', error=str(ex)), 'error')
 
 
+.. _raise-exceptions-instead-of-flash:
+
 Raise exceptions instead of flash error messages
 ------------------------------------------------
 

doc/api/index.rst

@@ -5,6 +5,7 @@ API
    :maxdepth: 2
 
    mod_base
+   mod_theme
    mod_helpers
    mod_model
    mod_form

doc/api/mod_base.rst

@@ -3,6 +3,15 @@
 
 .. automodule:: flask_admin.base
 
+    .. better to view Admin class first than BaseView class ..
+
+    Admin
+    -----
+
+    .. autoclass:: Admin
+        :members:
+
+
     Base View
     ---------
 
@@ -12,14 +21,8 @@
     .. autoclass:: BaseView
         :members:
 
-    Default view
-    ------------
+    Default (Index) view
+    --------------------
 
     .. autoclass:: AdminIndexView
         :members:
-
-    Admin
-    -----
-
-    .. autoclass:: Admin
-        :members:

doc/api/mod_theme.rst

@@ -0,0 +1,10 @@
+``flask_admin.theme``
+=====================
+
+.. automodule:: flask_admin.theme
+
+    BootstrapTheme
+    --------------
+
+    .. autoclass:: BootstrapTheme
+        :members:

doc/introduction.rst

@@ -55,12 +55,23 @@ The first step is to initialize an empty admin interface for your Flask app::
 
     app.run()
 
-Here, both the *name* and *theme* parameters are optional. Alternatively,
-you could use the :meth:`~flask_admin.base.Admin.init_app` method.
+Here, both the *name* and *theme* parameters are optional, have a look to the API
+:class:`~flask_admin.base.Admin` for more details about all other parameters.
+Alternatively, you could use the :meth:`~flask_admin.base.Admin.init_app` method.
 
 If you start this application and navigate to `http://localhost:5000/admin/ <http://localhost:5000/admin/>`_,
 you should see an empty page with a navigation bar on top. Customize the look by
 specifying one of the included Bootswatch themes (see https://bootswatch.com/4/ for a preview of the swatches).
+Here is list of all available themes:::
+
+  all_themes = [
+    "default", "cerulean", "cosmo", "cyborg",  "darkly",
+    "flatly", "journal", "litera", "lumen", "lux", "materia",
+    "minty", "pulse", "sandstone", "simplex", "sketchy", "slate",
+    "solar", "spacelab",  "superhero", "united", "yeti"
+  ]
+
+
 
 Adding Model Views
 ------------------
@@ -396,6 +407,56 @@ For this you could override only the view in question, and all the links to it w
 
         return self.render('create_user.html')
 
+
+Configure Views
+---------------
+Views can be configured by changing some Environment variables.
+
+
+=============================== ==============================================
+Variable                        Desctiption
+=============================== ==============================================
+Geographical Map views          To enable use of maps:
+
+                                ``FLASK_ADMIN_MAPS``
+
+                                Usually Works with:
+
+                                ``FLASK_ADMIN_DEFAULT_CENTER_LAT``
+
+                                ``FLASK_ADMIN_DEFAULT_CENTER_LONG``
+
+                                Can be integrated with MapBox using:
+
+                                ``FLASK_ADMIN_MAPBOX_MAP_ID``
+
+                                ``FLASK_ADMIN_MAPBOX_ACCESS_TOKEN``
+
+                                And can use with Google Search with:
+
+                                ``FLASK_ADMIN_MAPS_SEARCH``
+
+                                ``FLASK_ADMIN_GOOGLE_MAPS_API_KEY``
+
+                                see more :ref:`display-map-widgets`
+
+Exception handling               To show exceptions on the output rather than
+                                 flash messages:
+
+                                 ``FLASK_ADMIN_RAISE_ON_VIEW_EXCEPTION``
+
+                                 ``FLASK_ADMIN_RAISE_ON_INTEGRITY_ERROR``
+
+                                 ``FLASK_ADMIN_RAISE_ON_INTEGRITY_ERROR``
+
+                                 see more :ref:`raise-exceptions-instead-of-flash`
+=============================== ==============================================
+
+**Note:** The ``FLASK_ADMIN_SWATCH``, ``FLASK_ADMIN_FLUID_LAYOUT`` variables are
+deprecated and moved to :class:`~flask_admin.theme.BootstrapTheme`
+
+
+
 Working With the Built-in Templates
 ===================================
 

flask_admin/theme.py

@@ -11,6 +11,19 @@ class Theme:
 
 @dataclass
 class BootstrapTheme(Theme):
+    """
+    Bootstrap theme for Flask-Admin.
+
+    Usage::
+
+        t = Bootstrap4Theme(
+            base_template='my_base.html', # relative your templates folder
+            swatch='cerulean',
+            fluid=True
+        )
+        admin = Admin(app, name='microblog', theme=t)
+    """
+
     folder: typing.Literal["bootstrap4"]
     base_template: str = "admin/base.html"
     swatch: str = "default"