django/docs
Thomas Grainger 21683011d5 Added SuspiciousOperation to list of caught exceptions in testing docs. 2014-09-24 13:04:11 -04:00
..
_ext Added sphinx extension to ease generation of ticket links. 2014-08-19 17:40:50 -04:00
_theme
faq Fixed #23527 -- Removed Cheetah references in docs 2014-09-21 18:03:31 +02:00
howto Removed sudo from pip commands in docs. 2014-09-22 15:49:48 -04:00
internals Removed sudo from pip commands in docs. 2014-09-22 15:49:48 -04:00
intro Removed sudo from pip commands in docs. 2014-09-22 15:49:48 -04:00
man
misc
ref Fixed #23426 -- Don't require double percent sign in RunSQL without parameters 2014-09-24 07:20:57 -04:00
releases Fixed #23426 -- Don't require double percent sign in RunSQL without parameters 2014-09-24 07:20:57 -04:00
topics Added SuspiciousOperation to list of caught exceptions in testing docs. 2014-09-24 13:04:11 -04:00
Makefile
README Removed sudo from pip commands in docs. 2014-09-22 15:49:48 -04:00
conf.py Added sphinx extension to ease generation of ticket links. 2014-08-19 17:40:50 -04:00
contents.txt
glossary.txt Fixed #23281 -- Added "concrete model" to glossary. 2014-09-08 08:45:47 -04:00
index.txt Fixed #17101 -- Integrated django-secure and added check --deploy option 2014-09-12 15:05:23 -04:00
make.bat
spelling_wordlist Fixed typo in docs/internals/roles.txt and added words to spelling_wordlist. 2014-09-16 08:38:51 -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 ``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/