Skip to content

Commit

Permalink
Fixed some documentation and default-settings.py comments that were m…
Browse files Browse the repository at this point in the history
…isleading 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
  • Loading branch information
carljm committed Feb 1, 2011
1 parent 9a82eb6 commit 76fb2bb
Show file tree
Hide file tree
Showing 4 changed files with 24 additions and 19 deletions.
16 changes: 11 additions & 5 deletions django/conf/project_template/settings.py
Original file line number Diff line number Diff line change
Expand Up @@ -52,21 +52,27 @@
# Examples: "http://media.lawrence.com/media/", "http://example.com/media/"
MEDIA_URL = ''

# Absolute path to the directory that holds static files.
# Absolute path to the directory static files should be collected to.
# Don't put anything in this directory yourself; store your static files
# in apps' "static/" subdirectories and in STATICFILES_DIRS.
# Example: "/home/media/media.lawrence.com/static/"
STATIC_ROOT = ''

# URL that handles the static files served from STATIC_ROOT.
# URL prefix for static files.
# Example: "http://media.lawrence.com/static/"
STATIC_URL = '/static/'

# URL prefix for admin media -- CSS, JavaScript and images.
# URL prefix for admin static files -- CSS, JavaScript and images.
# Make sure to use a trailing slash.
# Examples: "http://foo.com/static/admin/", "/static/admin/".
ADMIN_MEDIA_PREFIX = '/static/admin/'

# A list of locations of additional static files
STATICFILES_DIRS = ()
# Additional locations of static files
STATICFILES_DIRS = (
# Put strings here, like "/home/html/static" or "C:/www/django/static".
# Always use forward slashes, even on Windows.
# Don't forget to use absolute paths, not relative paths.
)

# List of finder classes that know how to find static files in
# various locations.
Expand Down
1 change: 0 additions & 1 deletion django/contrib/staticfiles/finders.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
import os
from django.conf import settings
from django.db import models
from django.core.exceptions import ImproperlyConfigured
from django.core.files.storage import default_storage, Storage, FileSystemStorage
from django.utils.datastructures import SortedDict
Expand Down
2 changes: 0 additions & 2 deletions docs/ref/contrib/staticfiles.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
24 changes: 13 additions & 11 deletions docs/ref/settings.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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</ref/contrib/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</howto/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</ref/contrib/staticfiles>`'s
(default) the :djadmin:`collectstatic` management command will collect static
files into this directory. See the howto on :doc:`managing static
files</howto/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</ref/contrib/staticfiles>`'s
:setting:`finders<STATICFILES_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</ref/contrib/staticfiles>` and
:setting:`STATIC_URL`.
Expand Down

0 comments on commit 76fb2bb

Please sign in to comment.