django/docs
David Hoffman 6d5daa30cf Fixed #22553 -- Added refreshing queryset info to docs. 2014-07-26 10:27:02 -04:00
..
_ext
_theme
faq Fixed #22880 -- Added FAQ entry about UnicodeDecodeError 2014-06-24 09:02:28 +02:00
howto Fixed #22809 -- Added model Field API reference. 2014-07-10 06:03:04 -04:00
internals Fixed #23103 -- Added contributing tutorial link to contributing index. 2014-07-26 09:50:05 -04:00
intro Added warning in tutorial 4 that the regex capture group name has changed. 2014-07-22 14:00:22 -04:00
man
misc Fixed #16785 -- Documented some of the design decisions of the cache framework. 2014-01-16 21:13:08 -05:00
ref Fixed #22553 -- Added refreshing queryset info to docs. 2014-07-26 10:27:02 -04:00
releases Fixed #23097 -- Switched to new octal format in docs 2014-07-26 11:20:24 +02:00
topics Fixed #23097 -- Switched to new octal format in docs 2014-07-26 11:20:24 +02:00
Makefile
README
conf.py
contents.txt
glossary.txt
index.txt Fixed #22812 -- Refactored lookup API documentation. 2014-07-08 20:05:49 -04:00
make.bat
spelling_wordlist

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/