django1/docs
Tim Graham b63acdfe71 Removed a u'' prefix that prevented the docs from building on Python 3.2. 2013-12-06 13:06:59 -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 Fixed #21479 -- Favor 'migrate' over 'syncdb' in the docs. 2013-11-21 15:12:39 +01:00
howto Fixed another typo in custom model field documentation. 2013-12-05 23:11:30 +01:00
internals Fixed #21538 -- Added numpy to test/requirements/base.txt 2013-12-02 13:37:59 -05:00
intro Fixed #21562 -- Warned against using the same app name as a django contrib app. 2013-12-05 19:09:45 -05: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 Fixed #13476 -- Added support for color in console output under Windows. 2013-12-02 23:18:04 -03:00
releases List 1.6.x releases in descending order 2013-12-04 21:32:41 +00:00
topics Fixing manager documentation inaccuracy 2013-12-04 18:03:28 -06:00
Makefile Allowed overriding variables in docs/Makefile. 2013-07-29 06:51:54 -04:00
README Whitespace cleanup. 2013-10-10 16:49:20 -04:00
conf.py Fixed all E261 warnings 2013-11-02 18:20:39 -04:00
contents.txt Removed an obsolete documentation page about admin style customization. 2012-09-10 17:19:35 -07:00
glossary.txt Fixed #18451 -- Vastly improved class based view documentation. 2012-06-11 10:40:23 +02:00
index.txt Added link to localized formatting doc from main index. 2013-12-04 10:26:03 -03:00
make.bat Fixed #19516 - Fixed remaining broken links. 2013-01-02 18:32:57 -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 ``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/