django

mirror of https://github.com/django/django.git synced 2024-12-23 17:46:27 +00:00

History

Carl Meyer 0bf5fbfa76 Some tweaks to the staticfiles docs to clarify things for new users. Thanks Jannis and brutasse for review and discussion. * Rearranged 'in a nutshell' usage docs to clarify app-dirs vs STATICFILES_DIRS, initially focus on the simplest path to working local dev, and remove the need for repetitive 'you don't need this in local dev' notes. * Added docs on using staticfiles serve view for non-staticfiles (e.g. user-uploaded files). git-svn-id: http://code.djangoproject.com/svn/django/trunk@15380 bcc190cf-cafb-0310-a4f2-bffc1f526a37		2011-01-31 22:06:53 +00:00
..
_ext
_theme/djangodocs
faq
howto	Some tweaks to the staticfiles docs to clarify things for new users. Thanks Jannis and brutasse for review and discussion.	2011-01-31 22:06:53 +00:00
internals
intro
man
misc
obsolete
ref	Some tweaks to the staticfiles docs to clarify things for new users. Thanks Jannis and brutasse for review and discussion.	2011-01-31 22:06:53 +00:00
releases
topics
conf.py
contents.txt
glossary.txt
index.txt
Makefile
README

README

The documentation in this tree is in plain text files and can be viewed using
any text file viewer.

Technically speaking, it uses ReST (reStructuredText) [1], and the Sphinx
documentation system [2].  This allows it to be built into other forms for
easier viewing and browsing.

To create an HTML version of the docs on a Unix machine (Linux or Mac):

* Install Sphinx (using ``easy_install Sphinx`` or some other method)

* In this docs/ directory, type ``make html`` at a shell prompt.

The documentation in _build/html/index.html can then be viewed in a web browser.

[1] http://docutils.sourceforge.net/rst.html
[2] http://sphinx.pocoo.org/