Commits

Jeffrey Gelens  committed 6aeb755

Updated docs with staticfiles option

  • Participants
  • Parent commits 78a02bc

Comments (0)

Files changed (2)

File docs/configuration.rst

 
 django-admin-tools is composed of several modules:
 
-* admin_tools.theming: an app that makes it easy to customize the look 
+* admin_tools.theming: an app that makes it easy to customize the look
   and feel of the admin interface;
 
-* admin_tools.menu: a customizable navigation menu that sits on top of 
+* admin_tools.menu: a customizable navigation menu that sits on top of
   every django administration index page;
 
-* admin_tools.dashboard: a customizable dashboard that replaces the django 
+* admin_tools.dashboard: a customizable dashboard that replaces the django
   administration index page.
 
 Prerequisite
 ~~~~~~~~~~~~
 
 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 
+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 
+    It is required that you use the django 1.1 syntax to declare the
     django admin urls, e.g.::
 
         urlpatterns = patterns('',
 Required settings
 ~~~~~~~~~~~~~~~~~
 
-First make sure you have the following template context processors 
+First make sure you have the following template context processors
 installed::
 
     TEMPLATE_CONTEXT_PROCESSORS = (
         'django.core.context_processors.media',
 
         # django 1.2 only
-        'django.contrib.messages.context_processors.messages', 
+        'django.contrib.messages.context_processors.messages',
 
         # required by django-admin-tools
         'django.core.context_processors.request',
     )
 
-Then, add the django-admin-tools modules to the ``INSTALLED_APPS`` like 
+Then, add the django-admin-tools modules to the ``INSTALLED_APPS`` like
 this::
 
     INSTALLED_APPS = (
     )
 
 .. note::
-    it is very important that you put the admin_tools modules **before** 
+    it is very important that you put the admin_tools modules **before**
     the ``django.contrib.admin module``, because django-admin-tools
-    overrides the default django admin templates, and this will not work 
+    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 in your ``INSTALLED_APPS``. 
+django-admin-tools is modular, so if you want to disable a particular
+module, just remove or comment it in your ``INSTALLED_APPS``.
 For example, if you just want to use the dashboard::
 
     INSTALLED_APPS = (
 Setting up the django-admin-tools media files
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-To do this you have two options:
+To do this you have three options:
 
-* create a symbolic link to the django-admin-tools media files to your 
+* the `staticfiles <http://docs.djangoproject.com/en/dev/ref/contrib/staticfiles/`_
+  contrib application in Django 1.3. For Django 1.2 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, 
+* 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 
+django-admin-tools will look for the media directory in the following
 settings variables (and in this order):
 
 * ``ADMIN_TOOLS_MEDIA_URL``;
 ----------------------------
 
 ``ADMIN_TOOLS_MEDIA_URL``
-    You can use this variable if you want to set the media url for 
+    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 
+    The path to your custom menu class, for example
     "yourproject.menu.CustomMenu".
 
 ``ADMIN_TOOLS_INDEX_DASHBOARD``
-    The path to your custom index dashboard, for example 
+    The path to your custom index dashboard, for example
     "yourproject.dashboard.CustomIndexDashboard".
 
 ``ADMIN_TOOLS_APP_INDEX_DASHBOARD``
-    The path to your custom app index dashboard, for example 
+    The path to your custom app index dashboard, for example
     "yourproject.dashboard.CustomAppIndexDashboard".
 
 ``ADMIN_TOOLS_THEMING_CSS``

File docs/installation.rst

 `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.
+
 For further information, consult the `Django download page
 <http://www.djangoproject.com/download/>`_, which offers convenient
 packaged downloads and installation instructions.
 
 .. note::
-    If you want to display feeds in the admin dashboard, using the 
-    ``FeedDashboardModule`` you need to install the 
+    If you want to display feeds in the admin dashboard, using the
+    ``FeedDashboardModule`` you need to install the
     `Universal Feed Parser module <http://www.feedparser.org/>`_.
 
 
     pip install django-admin-tools
 
 It is also possible that your operating system distributor provides a
-packaged version of django-admin-tools. Consult your operating system's 
-package list for details, but be aware that third-party distributions 
-may be providing older versions of django-admin-tools, and so you 
-should consult the documentation which comes with your operating 
+packaged version of django-admin-tools. Consult your operating system's
+package list for details, but be aware that third-party distributions
+may be providing older versions of django-admin-tools, and so you
+should consult the documentation which comes with your operating
 system's package.
 
 
     python setup.py install
 
 .. note::
-    On some systems you may need to execute this with administrative 
+    On some systems you may need to execute this with administrative
     privileges (e.g., ``sudo python setup.py install``).
 
 
 
     hg clone http://bitbucket.org/izi/django-admin-tools/
 
-This will create a copy of the django-admin-tools Mercurial repository 
-on your computer; you can then add the ``django-admin-tools`` directory 
-to your Python import path, or use the ``setup.py`` script to install 
+This will create a copy of the django-admin-tools Mercurial repository
+on your computer; you can then add the ``django-admin-tools`` directory
+to your Python import path, or use the ``setup.py`` script to install
 as a package.