diff --git a/docs/static_files.txt b/docs/static_files.txt index 034cb976a3..333bb12e22 100644 --- a/docs/static_files.txt +++ b/docs/static_files.txt @@ -36,6 +36,8 @@ Just put this in your URLconf_:: ...where ``site_media`` is the URL where your media will be rooted, and ``/path/to/media`` is the filesystem root for your media. +You must pass a ``document_root`` parameter to indicate the filesystem root. + Examples: * The file ``/path/to/media/foo.jpg`` will be made available at the URL @@ -49,6 +51,43 @@ Examples: .. _URLconf: http://www.djangoproject.com/documentation/url_dispatch/ +Directory listings +================== + +Optionally, you can pass a ``show_indexes`` parameter to the ``static.serve`` +view. This is ``False`` by default. If it's ``True``, Django will display file +listings for directories. + +Example:: + + (r'^site_media/(?P.*)$', 'django.views.static.serve', {'document_root': '/path/to/media', 'show_indexes': True}), + +You can customize the index view by creating a template called +``static/directory_index``. That template gets two objects in its context: + + * ``directory`` -- the directory name (a string) + * ``file_list`` -- a list of file names (as strings) in the directory + +Here's the default ``static/directory_index`` template:: + + + + + + + + Index of {{ directory }} + + +

Index of {{ directory }}

+ + + + Limiting use to DEBUG=True ==========================