django/docs
Tim Graham 7ef81b5cdd Removed thread customizations of six which are now built-in. 2014-11-13 10:30:53 +01:00
..
_ext
_theme
faq
howto Fixed versionchanged indentation in docs/. 2014-11-03 21:40:26 -05:00
internals Fixed #23775 -- Added docs for --bisect and --pair runtests options. 2014-11-12 20:46:34 +01:00
intro Replaced dead links to python-distribute.org. 2014-10-24 18:58:31 -04: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 #23774 -- Clarified QuerySet.order_by() and related models. 2014-11-12 22:00:48 +01:00
releases Fixed #23795 -- Fixed a regression in custom form fields 2014-11-12 22:38:18 +01:00
topics Removed thread customizations of six which are now built-in. 2014-11-13 10:30:53 +01:00
Makefile Fixed #22141 -- Added a spelling checker for documentation. 2014-03-07 09:29:23 -05:00
README
conf.py Removed simplejson inventory file from docs/conf.py. 2014-10-25 07:31:12 +03:00
contents.txt
glossary.txt Fixed some intersphinx references. 2014-10-16 20:00:17 -04:00
index.txt Moved CSRF docs out of contrib. 2014-11-03 07:47:39 -05:00
make.bat
spelling_wordlist Fixed spelling errors in docs. 2014-11-11 16:41:09 +01: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 ``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/