Commits

David Jean Louis committed 5a5392e

Updated CHANGELOG and docs

Comments (0)

Files changed (4)

 django-admin-tools changelog
 ============================
 
+Version 0.5.0, 26 February 2013:
+--------------------------------
+
+Important information if you are upgrading from a previous version
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Starting from this version, django-admin-tools requires Django 1.3 or
+superior. If you're running Django < 1.3, DO NOT UPGRADE and stay with
+the 0.4.1 version.
+
+* Compatibility with Django 1.4 and Django 1.5
+* Upgraded to latest jQuery / jQuery-ui
+* Many bug fixes and small improvements
+
+
 Version 0.4.1, 15 November 2011:
 --------------------------------
 

docs/configuration.rst

 
 In order to use django-admin-tools you obviously need to have configured
 your django admin site, if you didn't, please refer to the
-`relevant django documentation <http://docs.djangoproject.com/en/1.1/intro/tutorial02/#activate-the-admin-site>`_.
-
-.. important::
-    It is required that you use the django 1.1 syntax to declare the
-    django admin urls, e.g.::
-
-        urlpatterns = patterns('',
-            (r'^admin/', include(admin.site.urls)),
-        )
-
-    The old url style ``(r'^admin/(.*)', admin.site.root)`` won't work.
+`relevant django documentation <https://docs.djangoproject.com/en/dev/intro/tutorial02/>`_.
 
 Required settings
 ~~~~~~~~~~~~~~~~~
 
-First make sure you have the following template context processors
-installed::
-
-    TEMPLATE_CONTEXT_PROCESSORS = (
-        # default template context processors
-        'django.core.context_processors.auth',
-        'django.core.context_processors.debug',
-        'django.core.context_processors.i18n',
-        'django.core.context_processors.media',
-
-        # django 1.2 only
-        'django.contrib.messages.context_processors.messages',
-
-        # required by django-admin-tools
-        'django.core.context_processors.request',
-    )
+First make sure you have the ``django.core.context_processors.request``
+template context processor in your ``TEMPLATE_CONTEXT_PROCESSORS``.
 
 Then, add the django-admin-tools modules to the ``INSTALLED_APPS`` like
 this::
         #...other url patterns...
     )
 
-Setting up the django-admin-tools media files
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-To do this you have three options:
-
-* use the `staticfiles <http://docs.djangoproject.com/en/dev/ref/contrib/staticfiles/>`_
-  contrib application in Django 1.3. For Django 1.2 or lower you'll have to install
-  django-staticfiles from PyPi.
-
-* create a symbolic link to the django-admin-tools media files to your
-  ``MEDIA_ROOT`` directory, for example::
-
-      ln -s /usr/local/lib/python2.6/dist-packages/admin_tools/media/admin_tools /path/to/yourproject/media/
-
-* copy the django-admin-tools media files to your ``MEDIA_ROOT`` directory,
-  for example::
-
-      cp -r /usr/local/lib/python2.6/dist-packages/admin_tools/media/admin_tools /path/to/yourproject/media/
-
-django-admin-tools will look for the media directory in the following
-settings variables (and in this order):
-
-* ``ADMIN_TOOLS_MEDIA_URL``;
-* ``STATIC_URL``: use this if you are using django-staticfiles;
-* ``MEDIA_URL``.
-
-
-Here's an example config if you are using django development server:
-
-``urls.py``::
-
-    (r'^site_media/(?P<path>.*)$', 'django.views.static.serve',
-        {'document_root': '/path/to/media'}),
-
-``settings.py``::
-
-    MEDIA_URL = '/site_media/'
-
-
 Available settings variables
 ----------------------------
 
-``ADMIN_TOOLS_MEDIA_URL``
-    You can use this variable if you want to set the media url for
-    django-admin-tools to something different from your ``MEDIA_URL``.
-
 ``ADMIN_TOOLS_MENU``
     The path to your custom menu class, for example
     "yourproject.menu.CustomMenu".

docs/installation.rst

 
 Before installing django-admin-tools, you'll need to have a copy of
 `Django <http://www.djangoproject.com>`_ already installed. For the
-|version| release, Django 1.1 or newer is required.
-
-Optionally install django-staticfiles when using Django 1.2 or lower.
+|version| release, Django 1.3 or newer is required.
 
 For further information, consult the `Django download page
 <http://www.djangoproject.com/download/>`_, which offers convenient

docs/quickstart.rst

 
 Before installing django-admin-tools, you'll need to have a copy of
 `Django <http://www.djangoproject.com>`_ already installed. For the
-|version| release, Django 1.1 or newer is required.
+|version| release, Django 1.3 or newer is required.
 
 
 Installing django-admin-tools
 -----------------------------
 
-django-admin-tools requires Django version 1.1 or superior, optionally, 
+django-admin-tools requires Django version 1.3 or superior, optionally, 
 if you want to display feed modules, you'll also need the 
 `Universal Feed Parser module <http://www.feedparser.org/>`_.
 
 
 In order to use django-admin-tools you obviously need to have configured
 your Django admin site. If you didn't, please refer to the 
-`relevant Django documentation <http://docs.djangoproject.com/en/1.1/intro/tutorial02/#activate-the-admin-site>`_.
+`relevant django documentation <https://docs.djangoproject.com/en/dev/intro/tutorial02/>`_.
 
-.. important::
-    It is required that you use the Django 1.1 syntax to declare the 
-    Django admin urls, e.g.::
+Configuration
+~~~~~~~~~~~~~
 
-        urlpatterns = patterns('',
-            (r'^admin/', include(admin.site.urls)),
-        )
+First make sure you have the ``django.core.context_processors.request``
+template context processor in your ``TEMPLATE_CONTEXT_PROCESSORS``.
 
-    The old url style ``(r'^admin/(.*)', admin.site.root)`` won't work.
-
-Required settings
-~~~~~~~~~~~~~~~~~
-
-First make sure you have the following template context processors 
-installed::
-
-    TEMPLATE_CONTEXT_PROCESSORS = (
-        # default template context processors
-        'django.core.context_processors.auth',
-        'django.core.context_processors.debug',
-        'django.core.context_processors.i18n',
-        'django.core.context_processors.media',
-
-        # django 1.2 only
-        'django.contrib.messages.context_processors.messages', 
-
-        # required by django-admin-tools
-        'django.core.context_processors.request',
-    )
-
-Then, add admin_tools and its modules to the ``INSTALLED_APPS`` like 
-this::
+Then, add admin_tools and its modules to the ``INSTALLED_APPS`` like this::
 
     INSTALLED_APPS = (
         'admin_tools',
     overrides the default Django admin templates, and this will not work 
     otherwise.
 
-django-admin-tools is modular, so if you want to disable a particular 
-module, just remove or comment it out in your ``INSTALLED_APPS``, note 
-that ``admin_tools`` is required for i18n.
-
-
-Setting up the database
-~~~~~~~~~~~~~~~~~~~~~~~
-
-To set up the tables that django-admin-tools uses you'll need to type::
-
-    python manage.py syncdb
-
-django-admin-tools supports `South <http://south.aeracode.org>`_, so if you
-have South installed, make sure you run the following commands::
-
-    python manage.py migrate admin_tools.dashboard
-    python manage.py migrate admin_tools.menu
-
-Adding django-admin-tools to your urls.py file
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-You'll need to add django-admin-tools to your urls.py file::
+Then, just add django-admin-tools to your urls.py file::
 
     urlpatterns = patterns('',
         url(r'^admin_tools/', include('admin_tools.urls')),
         #...other url patterns...
     )
 
-Setting up the django-admin-tools media files
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Finally simply run::
 
-To do this you have three options:
+    python manage.py syncdb
 
-* use the `staticfiles <http://docs.djangoproject.com/en/dev/ref/contrib/staticfiles/>`_
-  contrib application in Django 1.3. For Django 1.2 or lower you'll have to install
-  django-staticfiles from PyPi.
+If you have South installed, make sure you run the following commands::
 
-* create a symbolic link to the django-admin-tools media files to your
-  ``MEDIA_ROOT`` directory, for example::
-
-      ln -s /usr/local/lib/python2.6/dist-packages/admin_tools/media/admin_tools /path/to/yourproject/media/
-
-* copy the django-admin-tools media files to your ``MEDIA_ROOT`` directory,
-  for example::
-
-      cp -r /usr/local/lib/python2.6/dist-packages/admin_tools/media/admin_tools /path/to/yourproject/media/
-
+    python manage.py migrate admin_tools.dashboard
+    python manage.py migrate admin_tools.menu
 
 Testing your new shiny admin interface
 --------------------------------------