django/docs
Tim Graham 5c143cb340 Fixed #19180 - Clarified policy regarding older versions of the docs. 2012-10-25 17:55:42 -04:00
..
_ext
_theme/djangodocs
faq
howto
internals Fixed #19180 - Clarified policy regarding older versions of the docs. 2012-10-25 17:55:42 -04:00
intro Fixed #19180 - Clarified policy regarding older versions of the docs. 2012-10-25 17:55:42 -04:00
man
misc
ref
releases
topics Fixed #7581 -- Added streaming responses. 2012-10-20 20:05:11 +02:00
Makefile
README Fixed #18928. Tightened language in docs/README. 2012-09-08 11:11:37 +05:30
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 Added gettext target to sphinx makefiles. 2012-04-07 22:35:57 +00: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.pocoo.org/