django/docs
Brett Koonce 946a2226ea Removed extra p (topppings->toppings) 2013-09-23 19:24:40 -04:00
..
_ext
_theme/djangodocs
faq
howto
internals
intro Fixed #21141 -- Update Sphinx URL 2013-09-22 14:44:09 -03:00
man
misc
ref Removed extra p (topppings->toppings) 2013-09-23 19:24:40 -04:00
releases
topics Removed implication that six is part of Python stdlib. 2013-09-23 18:30:05 -04:00
Makefile
README
conf.py
contents.txt
glossary.txt Fixed #18451 -- Vastly improved class based view documentation. 2012-06-11 10:40:23 +02:00
index.txt
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/