From 76fb2bb0e246884ce6dc1a48d0db55e0673de8e0 Mon Sep 17 00:00:00 2001 From: Carl Meyer Date: Tue, 1 Feb 2011 14:28:07 +0000 Subject: Fixed some documentation and default-settings.py comments that were misleading about the purpose of STATIC_ROOT, and removed an unused import. git-svn-id: http://code.djangoproject.com/svn/django/trunk@15384 bcc190cf-cafb-0310-a4f2-bffc1f526a37 --- docs/ref/contrib/staticfiles.txt | 2 -- docs/ref/settings.txt | 24 +++++++++++++----------- 2 files changed, 13 insertions(+), 13 deletions(-) (limited to 'docs') diff --git a/docs/ref/contrib/staticfiles.txt b/docs/ref/contrib/staticfiles.txt index 4944c284d2..dd26fe535b 100644 --- a/docs/ref/contrib/staticfiles.txt +++ b/docs/ref/contrib/staticfiles.txt @@ -26,8 +26,6 @@ Settings .. note:: The following settings control the behavior of the staticfiles app. - Configuring the global settings :setting:`STATIC_ROOT` and - :setting:`STATIC_URL` is **required**. .. setting:: STATICFILES_DIRS diff --git a/docs/ref/settings.txt b/docs/ref/settings.txt index d21c3ab044..68c5ad092f 100644 --- a/docs/ref/settings.txt +++ b/docs/ref/settings.txt @@ -1628,22 +1628,24 @@ STATIC_ROOT Default: ``''`` (Empty string) -The absolute path to the directory that contains static files. +The absolute path to the directory where :djadmin:`collectstatic` will collect +static files for deployment. Example: ``"/home/example.com/static/"`` If the :doc:`staticfiles` contrib app is enabled -(default) this will be used as the directory which the -:djadmin:`collectstatic` management command collects static files in. See -the howto on :doc:`managing static files` for more -details about usage. - -.. warning:: This is not a place to store your static files permanently; - you should do that in directories that will be found by - :doc:`staticfiles`'s +(default) the :djadmin:`collectstatic` management command will collect static +files into this directory. See the howto on :doc:`managing static +files` for more details about usage. + +.. warning:: This should be an (initially empty) destination directory for + collecting your static files from their permanent locations into one + directory for ease of deployment; it is **not** a place to store your + static files permanently. You should do that in directories that will be + found by :doc:`staticfiles`'s :setting:`finders`, which by default, are - ``'static'`` app sub directories and any directories you include in - the :setting:`STATICFILES_DIRS`). + ``'static/'`` app sub-directories and any directories you include in + :setting:`STATICFILES_DIRS`). See :doc:`staticfiles reference` and :setting:`STATIC_URL`. -- cgit v1.3