django/docs
Tim Graham 60d2dde286 Fixed #22247 -- Replaced "upstream" with "downstream" in cache docs.
Thanks valgarv at gmx.net for the report.
2014-03-24 09:19:27 -04:00
..
_ext
_theme
faq Removed PIL compatability layer per deprecation timeline. 2014-03-21 10:54:53 -04:00
howto Fixed #21179 -- Added a StreamingHttpResponse example for CSV files. 2014-03-17 07:22:27 -04:00
internals
intro
man
misc Fixed #16785 -- Documented some of the design decisions of the cache framework. 2014-01-16 21:13:08 -05:00
ref Fixed #17922 -- Added required_css_class to form label. 2014-03-24 08:11:54 -04:00
releases Fixed #21665 -- Documented that changes in assertRedirects may be required given new URL escaping behavior. 2014-03-24 09:08:47 -04:00
topics Fixed #22247 -- Replaced "upstream" with "downstream" in cache docs. 2014-03-24 09:19:27 -04:00
Makefile
README Whitespace cleanup. 2013-10-10 16:49:20 -04:00
conf.py
contents.txt Removed an obsolete documentation page about admin style customization. 2012-09-10 17:19:35 -07:00
glossary.txt
index.txt
make.bat Fixed #19516 - Fixed remaining broken links. 2013-01-02 18:32:57 -05:00
spelling_wordlist Updated spelling_wordlist. 2014-03-11 08:11:16 -04:00

README

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

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:

* Install Sphinx (using ``sudo pip install Sphinx`` or some other method)

* In this docs/ directory, type ``make html`` (or ``make.bat html`` on
  Windows) 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-doc.org/