summaryrefslogtreecommitdiff
path: root/docs/ref
diff options
context:
space:
mode:
authorCarl Meyer <carl@oddbird.net>2011-02-01 14:28:07 +0000
committerCarl Meyer <carl@oddbird.net>2011-02-01 14:28:07 +0000
commit76fb2bb0e246884ce6dc1a48d0db55e0673de8e0 (patch)
treea1d7a8296e7b0462a7b009151454995678b439be /docs/ref
parent9a82eb6ff109e95dbb6cf26ee3d2ce1c548714bb (diff)
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
Diffstat (limited to 'docs/ref')
-rw-r--r--docs/ref/contrib/staticfiles.txt2
-rw-r--r--docs/ref/settings.txt22
2 files changed, 12 insertions, 12 deletions
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</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.
+(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 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
+.. 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`.