django/docs
Aymeric Augustin b2d20e9826 Removed legacy shortcut for importing GeoIP. 2012-12-29 21:58:12 +01:00
..
_ext
_theme/djangodocs
faq Updated installation FAQ entry on Python versions. 2012-12-25 00:26:46 +01:00
howto Fixed broken links, round 4. refs #19516 2012-12-29 15:54:33 -05:00
internals Fixed broken links, round 4. refs #19516 2012-12-29 15:54:33 -05:00
intro Fixed broken links, round 3. refs #19516 2012-12-26 19:07:22 -05:00
man
misc Fixed #19498 -- refactored auth documentation 2012-12-28 11:06:12 -08:00
ref Removed legacy shortcut for importing GeoIP. 2012-12-29 21:58:12 +01:00
releases Fixed broken links, round 4. refs #19516 2012-12-29 15:54:33 -05:00
topics Fixed broken links, round 4. refs #19516 2012-12-29 15:54:33 -05:00
Makefile
README Fixed #18928. Tightened language in docs/README. 2012-09-08 11:11:37 +05:30
conf.py Fixed broken links, round 3. refs #19516 2012-12-26 19:07:22 -05:00
contents.txt
glossary.txt Fixed #18451 -- Vastly improved class based view documentation. 2012-06-11 10:40:23 +02:00
index.txt Removed django.contrib.databrowse. 2012-12-29 21:58:12 +01: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.pocoo.org/