1
0
mirror of https://github.com/django/django.git synced 2025-01-09 18:06:34 +00:00
django/docs
2013-06-09 15:05:15 -04:00
..
_ext
_theme/djangodocs
faq
howto
internals Update submitting-patches.txt 2013-06-08 14:53:27 +09:00
intro Fixed #19875 - Added warnings regarding DEBUG=False and empty ALLOWED_HOSTS 2013-06-09 15:05:15 -04:00
man
misc
ref Fixed #19875 - Added warnings regarding DEBUG=False and empty ALLOWED_HOSTS 2013-06-09 15:05:15 -04:00
releases Proofed the 1.6 release notes 2013-06-05 12:55:58 -04:00
topics Fixed #19875 - Added warnings regarding DEBUG=False and empty ALLOWED_HOSTS 2013-06-09 15:05:15 -04:00
conf.py Allow build of translated documentation 2013-06-08 16:13:51 +02:00
contents.txt
glossary.txt
index.txt
make.bat
Makefile Allow build of translated documentation 2013-06-08 16:13:51 +02: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.pocoo.org/