django/docs
Tim Graham 8bb9e7c999 Fixed spelling in docs/ref/django-admin.txt. 2014-11-24 08:32:07 -05:00
..
_ext
_theme
faq Fixed #23527 -- Removed Cheetah references in docs 2014-09-21 18:03:31 +02:00
howto Fixed #20435 -- Reordered the custom template tags docs. 2014-11-17 17:38:04 +01:00
internals Fixed typo in docs/internals/release-process.txt. 2014-11-21 11:47:31 -05:00
intro Fixed #23855 -- Removed unnecessary all() in tutorial 3. 2014-11-17 18:10:50 +01:00
man Fixed #18714 -- Added 'fuzzy' compilemessages option 2014-11-18 22:44:16 +01:00
misc Fixed #16785 -- Documented some of the design decisions of the cache framework. 2014-01-16 21:13:08 -05:00
ref Fixed spelling in docs/ref/django-admin.txt. 2014-11-24 08:32:07 -05:00
releases Moved release note for refs #21281 from "deprecation" to "backwards incompatible". 2014-11-24 07:31:05 -05:00
topics Fixed #23900 -- Added missing imports in code example. 2014-11-23 23:03:58 +01:00
Makefile
README
conf.py
contents.txt
glossary.txt
index.txt Fixed #14030 -- Allowed annotations to accept all expressions 2014-11-15 14:00:43 +00:00
make.bat
spelling_wordlist Fixed spelling in docs/ref/django-admin.txt. 2014-11-24 08:32:07 -05: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/