From 2e39f805fe2bfdc33a3c28e320d079a1a2644a73 Mon Sep 17 00:00:00 2001 From: Artur Barseghyan Date: Fri, 20 Feb 2015 10:34:18 +0100 Subject: [PATCH] mention that some plugins may require additional dependencies that should be mentioned in INSTALLED_APPS; mention that easy_thumbnails is required with content_image plugin --- README.rst | 7 ++++++- docs/index.rst | 7 ++++++- .../plugins/form_elements/content/content_image/README.rst | 1 + 3 files changed, 13 insertions(+), 2 deletions(-) diff --git a/README.rst b/README.rst index f60b9acd..1ff87ec1 100644 --- a/README.rst +++ b/README.rst @@ -182,7 +182,9 @@ Or latest stable version from BitBucket: (2) Add `fobi` to ``INSTALLED_APPS`` of the your projects' Django settings. Furthermore, all themes and plugins to be used, shall be added to the - ``INSTALLED_APPS`` as well. + ``INSTALLED_APPS`` as well. Note, that if a plugin has additional + dependencies, you should be mentioning those in the ``INSTALLED_APPS`` + as well. .. code-block:: python @@ -215,6 +217,7 @@ Or latest stable version from BitBucket: # Fobi form elements - content elements 'fobi.contrib.plugins.form_elements.test.dummy', + 'easy_thumbnails', # Required by `content_image` plugin 'fobi.contrib.plugins.form_elements.content.content_image', 'fobi.contrib.plugins.form_elements.content.content_text', 'fobi.contrib.plugins.form_elements.content.content_video', @@ -229,6 +232,8 @@ Or latest stable version from BitBucket: # ... ) + + (3) Make appropriate changes to the ``TEMPLATE_CONTEXT_PROCESSORS`` of the your projects' Django settings. diff --git a/docs/index.rst b/docs/index.rst index ae138409..7447c4c1 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -182,7 +182,9 @@ Or latest stable version from BitBucket: (2) Add `fobi` to ``INSTALLED_APPS`` of the your projects' Django settings. Furthermore, all themes and plugins to be used, shall be added to the - ``INSTALLED_APPS`` as well. + ``INSTALLED_APPS`` as well. Note, that if a plugin has additional + dependencies, you should be mentioning those in the ``INSTALLED_APPS`` + as well. .. code-block:: python @@ -215,6 +217,7 @@ Or latest stable version from BitBucket: # Fobi form elements - content elements 'fobi.contrib.plugins.form_elements.test.dummy', + 'easy_thumbnails', # Required by `content_image` plugin 'fobi.contrib.plugins.form_elements.content.content_image', 'fobi.contrib.plugins.form_elements.content.content_text', 'fobi.contrib.plugins.form_elements.content.content_video', @@ -229,6 +232,8 @@ Or latest stable version from BitBucket: # ... ) + + (3) Make appropriate changes to the ``TEMPLATE_CONTEXT_PROCESSORS`` of the your projects' Django settings. diff --git a/src/fobi/contrib/plugins/form_elements/content/content_image/README.rst b/src/fobi/contrib/plugins/form_elements/content/content_image/README.rst index c3fe3139..f18e4312 100644 --- a/src/fobi/contrib/plugins/form_elements/content/content_image/README.rst +++ b/src/fobi/contrib/plugins/form_elements/content/content_image/README.rst @@ -12,6 +12,7 @@ Installation INSTALLED_APPS = ( # ... + 'easy_thumbnails', 'fobi.contrib.plugins.form_elements.content.content_image', # ... )