django/docs
Tim Graham 90577c0eb4 Removed WSGI upgrade instructions for Django 1.3 and earlier. 2014-03-02 16:19:28 -05:00
..
_ext Fixed #21869 -- Fixed docs building with Sphinx 1.2.1. 2014-01-24 08:52:43 -05:00
_theme Fixed #21190 -- Added a new ePub theme for documentation. 2014-02-10 08:24:40 -05:00
faq
howto Removed WSGI upgrade instructions for Django 1.3 and earlier. 2014-03-02 16:19:28 -05:00
internals Fixed #22130 -- Deprecated fix_ampersands, removed utils.clean_html() 2014-03-01 14:07:57 +01:00
intro Fixed some typos in the documentation. 2014-03-02 17:05:57 +01: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 some typos in the documentation. 2014-03-02 17:05:57 +01:00
releases Fixed #22172 -- Allowed index_together to be a single list (rather than list of lists).. 2014-03-01 15:44:42 -05:00
topics Fixed some typos in the documentation. 2014-03-02 17:05:57 +01:00
Makefile
README
conf.py Fixed #21190 -- Added a new ePub theme for documentation. 2014-02-10 08:24:40 -05:00
contents.txt
glossary.txt Fixed some typos in the documentation. 2014-03-02 17:05:57 +01:00
index.txt Add reference documentation for operations and stubs for schemaeditor. 2014-02-12 18:53:35 +00:00
make.bat

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/