django

mirror of https://github.com/django/django.git synced 2024-12-24 10:05:46 +00:00

History

Tim Graham ccd80dc3b6 Added 1.6.2 release notes stub.		2013-12-13 18:42:24 -05:00
..
_ext	Removed a u'' prefix that prevented the docs from building on Python 3.2.	2013-12-06 13:06:59 -05:00
_theme/djangodocs	Fixed #21558 -- Support building CHM files.	2013-12-04 16:46:56 +01:00
faq	Updated a bunch of hyperlinks in documentation	2013-12-08 18:40:09 +01:00
howto	Updated a bunch of hyperlinks in documentation	2013-12-08 18:40:09 +01:00
internals	Removed an erroneous leading slash introduced by a626bdf648a.	2013-12-08 13:18:53 -05:00
intro	Updated a bunch of hyperlinks in documentation	2013-12-08 18:40:09 +01:00
man	Enabled makemessages to support several translation directories	2013-11-30 11:00:23 +01:00
misc	Whitespace cleanup.	2013-10-10 16:49:20 -04:00
ref	Changed documentation of HttpResponse.content to indicate it's a bytestring	2013-12-13 11:42:14 +01:00
releases	Added 1.6.2 release notes stub.	2013-12-13 18:42:24 -05:00
topics	Fixed #21560 -- missing 'slug' field in example code	2013-12-09 22:54:11 +01:00
conf.py	Fixed all E261 warnings	2013-11-02 18:20:39 -04:00
contents.txt
glossary.txt
index.txt	Updated a bunch of hyperlinks in documentation	2013-12-08 18:40:09 +01:00
make.bat
Makefile
README	Whitespace cleanup.	2013-10-10 16:49:20 -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/