Commit a7796c84 authored by Serge S. Koval's avatar Serge S. Koval

Doc updates

parent 36058f3d
...@@ -8,7 +8,7 @@ SQLAlchemy model backend implementation. ...@@ -8,7 +8,7 @@ SQLAlchemy model backend implementation.
.. autoclass:: ModelView .. autoclass:: ModelView
:members: :members:
:inherited-members: :inherited-members:
:exclude-members: column_hide_backrefs, column_auto_select_related, :exclude-members: column_auto_select_related,
column_select_related_list, column_searchable_list, column_select_related_list, column_searchable_list,
column_filters, filter_converter, model_form_converter, column_filters, filter_converter, model_form_converter,
inline_model_form_converter, fast_mass_delete, inline_model_form_converter, fast_mass_delete,
...@@ -16,7 +16,6 @@ SQLAlchemy model backend implementation. ...@@ -16,7 +16,6 @@ SQLAlchemy model backend implementation.
Class inherits configuration options from :class:`~flask.ext.admin.model.BaseModelView` and they're not displayed here. Class inherits configuration options from :class:`~flask.ext.admin.model.BaseModelView` and they're not displayed here.
.. autoattribute:: column_hide_backrefs
.. autoattribute:: column_auto_select_related .. autoattribute:: column_auto_select_related
.. autoattribute:: column_select_related_list .. autoattribute:: column_select_related_list
.. autoattribute:: column_searchable_list .. autoattribute:: column_searchable_list
......
...@@ -8,9 +8,16 @@ ...@@ -8,9 +8,16 @@
:exclude-members: can_create, can_edit, can_delete, list_template, edit_template, :exclude-members: can_create, can_edit, can_delete, list_template, edit_template,
create_template, column_list, column_exclude_list, column_labels, create_template, column_list, column_exclude_list, column_labels,
column_formatters, column_type_formatters, column_display_pk, column_formatters, column_type_formatters, column_display_pk,
column_descriptions, column_default_sort,
column_sortable_list, column_searchable_list, column_filters, column_sortable_list, column_searchable_list, column_filters,
column_choices,
form, form_columns, form_excluded_columns, form_args, form, form_columns, form_excluded_columns, form_args,
form_overrides, action_disallowed_list, page_size form_base_class,
form_overrides, action_disallowed_list,
form_widget_args, form_extra_fields,
form_ajax_refs, form_create_rules,
form_edit_rules,
page_size
.. autoattribute:: can_create .. autoattribute:: can_create
.. autoattribute:: can_edit .. autoattribute:: can_edit
...@@ -23,20 +30,30 @@ ...@@ -23,20 +30,30 @@
.. autoattribute:: column_list .. autoattribute:: column_list
.. autoattribute:: column_exclude_list .. autoattribute:: column_exclude_list
.. autoattribute:: column_labels .. autoattribute:: column_labels
:: autoattribute:: column_descriptions
.. autoattribute:: column_formatters .. autoattribute:: column_formatters
.. autoattribute:: column_type_formatters .. autoattribute:: column_type_formatters
.. autoattribute:: column_display_pk .. autoattribute:: column_display_pk
.. autoattribute:: column_sortable_list .. autoattribute:: column_sortable_list
.. autoattribute:: column_searchable_list .. autoattribute:: column_searchable_list
.. autoattribute:: column_default_sort
.. autoattribute:: column_choices
.. autoattribute:: column_filters .. autoattribute:: column_filters
.. autoattribute:: form .. autoattribute:: form
.. autoattribute:: form_base_class
.. autoattribute:: form_columns .. autoattribute:: form_columns
.. autoattribute:: form_excluded_columns .. autoattribute:: form_excluded_columns
.. autoattribute:: form_args .. autoattribute:: form_args
.. autoattribute:: form_overrides .. autoattribute:: form_overrides
.. autoattribute:: form_widget_args
.. autoattribute:: form_extra_fields
.. autoattribute:: form_ajax_refs
.. autoattribute:: form_create_rules
.. autoattribute:: form_edit_rules
.. autoattribute:: action_disallowed_list .. autoattribute:: action_disallowed_list
......
...@@ -3,11 +3,12 @@ MongoEngine backend ...@@ -3,11 +3,12 @@ MongoEngine backend
Features: Features:
- MongoEngine 0.7+ support; - MongoEngine 0.7+ support
- Paging, sorting, filters, etc; - Paging, sorting, filters, etc
- Inline editing of related models; - Supports complex document structure (lists, subdocuments and so on)
- GridFS support for file and image uploads
In order to use MongoEngine integration, you need to install `flask-mongoengine` package, In order to use MongoEngine integration, you need to install the `flask-mongoengine` package,
as Flask-Admin uses form scaffolding from it. as Flask-Admin uses form scaffolding from it.
You don't have to use Flask-MongoEngine in your project - Flask-Admin will work with "raw" You don't have to use Flask-MongoEngine in your project - Flask-Admin will work with "raw"
...@@ -15,7 +16,6 @@ MongoEngine models without any problems. ...@@ -15,7 +16,6 @@ MongoEngine models without any problems.
Known issues: Known issues:
- There's no way to configure EmbeddedDocument display options
- Search functionality can't split query into multiple terms due to - Search functionality can't split query into multiple terms due to
MongoEngine query language limitations MongoEngine query language limitations
......
...@@ -5,10 +5,10 @@ Flask-Admin comes with SQLAlchemy ORM backend. ...@@ -5,10 +5,10 @@ Flask-Admin comes with SQLAlchemy ORM backend.
Notable features: Notable features:
- SQLAlchemy 0.6+ support; - SQLAlchemy 0.6+ support
- Paging, sorting, filters; - Paging, sorting, filters
- Proper model relationship handling; - Proper model relationship handling
- Inline editing of related models. - Inline editing of related models
Getting Started Getting Started
--------------- ---------------
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment