django/docs
Tim Graham ec71191be0 Added release note stubs for 1.5.9 and 1.4.14. 2014-08-20 14:39:40 -04:00
..
_ext Added sphinx extension to ease generation of ticket links. 2014-08-19 17:40:50 -04:00
_theme
faq
howto Removed unnecessary code-block directives. 2014-08-19 16:44:25 -04:00
internals Added sphinx extension to ease generation of ticket links. 2014-08-19 17:40:50 -04:00
intro Removed unnecessary code-block directives. 2014-08-19 16:44:25 -04:00
man
misc
ref Fixed #10190 -- Made HttpResponse charset customizable. 2014-08-19 17:34:38 -04:00
releases Added release note stubs for 1.5.9 and 1.4.14. 2014-08-20 14:39:40 -04:00
topics Removed unnecessary code-block directives. 2014-08-19 16:44:25 -04:00
Makefile
README
conf.py Added sphinx extension to ease generation of ticket links. 2014-08-19 17:40:50 -04:00
contents.txt
glossary.txt
index.txt
make.bat
spelling_wordlist Added some words to spelling_wordlist. 2014-08-14 14:13:08 -04: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-doc.org/