1
0
mirror of https://github.com/django/django.git synced 2025-01-12 03:15:47 +00:00
django/docs
Russell Keith-Magee 576606a6f2 Advanced deprecations in core.cache.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@15977 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2011-04-02 08:37:15 +00:00
..
_ext
_theme/djangodocs
faq
howto Fixed some ReST errors from e-mail -> email change in docs, and changed some docs that shouldn't have been changed (because translation strings haven't been converted yet) 2011-04-01 16:18:23 +00:00
internals Advanced deprecations in core.cache. 2011-04-02 08:37:15 +00:00
intro
man
misc
obsolete
ref Advanced deprecation of user-based messages and the LegacyFallbackStorage in contrib.messages. 2011-04-02 08:36:04 +00:00
releases Fixed some ReST errors from e-mail -> email change in docs, and changed some docs that shouldn't have been changed (because translation strings haven't been converted yet) 2011-04-01 16:18:23 +00:00
topics Fixed some ReST errors from e-mail -> email change in docs, and changed some docs that shouldn't have been changed (because translation strings haven't been converted yet) 2011-04-01 16:18:23 +00:00
conf.py
contents.txt
glossary.txt
index.txt
Makefile
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/